From c53d3a9ee1b1c85c7d905fb8ca80d327a55f1dfb Mon Sep 17 00:00:00 2001
From: Robert Haas <rhaas@postgresql.org>
Date: Tue, 18 Oct 2011 20:13:27 -0400
Subject: [PATCH] Make the CHECKPOINT reference page more clear.
Josh Kupershmidt, reviewed by Fujii Masao
---
doc/src/sgml/ref/checkpoint.sgml | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml
index 7ffd40a605e..e70b8c8cb4a 100644
--- a/doc/src/sgml/ref/checkpoint.sgml
+++ b/doc/src/sgml/ref/checkpoint.sgml
@@ -25,31 +25,31 @@ CHECKPOINT
<refsect1>
<title>Description</title>
- <para>
- Write-Ahead Logging (WAL) puts a checkpoint in the transaction log
- every so often. (To adjust the automatic checkpoint interval, see
- the run-time configuration options <xref linkend="guc-checkpoint-segments">
- and <xref linkend="guc-checkpoint-timeout">.) The
- <command>CHECKPOINT</command> command forces an immediate
- checkpoint when the command is issued, without waiting for a
- scheduled checkpoint.
- </para>
-
<para>
A checkpoint is a point in the transaction log sequence at which
all data files have been updated to reflect the information in the
log. All data files will be flushed to disk. Refer to
- <xref linkend="wal"> for more information about the WAL system.
+ <xref linkend="wal-configuration"> for more details about what happens
+ during a checkpoint.
+ </para>
+
+ <para>
+ The <command>CHECKPOINT</command> command forces an immediate
+ checkpoint when the command is issued, without waiting for a
+ regular checkpoint scheduled by the system (controlled by the settings in
+ <xref linkend="runtime-config-wal-checkpoints">).
+ <command>CHECKPOINT</command> is not intended for use during normal
+ operation.
</para>
<para>
If executed during recovery, the <command>CHECKPOINT</command> command
- will force a restartpoint rather than writing a new checkpoint.
+ will force a restartpoint (see <xref linkend="wal-configuration">)
+ rather than writing a new checkpoint.
</para>
<para>
- Only superusers can call <command>CHECKPOINT</command>. The command is
- not intended for use during normal operation.
+ Only superusers can call <command>CHECKPOINT</command>.
</para>
</refsect1>
--
GitLab