Skip to content

Commit 5fc34ba

Browse files
committed
Improve recovery target settings documentation.
Commit 815d71d hadn't bothered to update the documentation to match the behavioral change, and a lot of other text in this section was badly in need of copy-editing.
1 parent 9ccae63 commit 5fc34ba

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

doc/src/sgml/recovery-config.sgml

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,16 +152,18 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
152152
<sect1 id="recovery-target-settings">
153153

154154
<title>Recovery Target Settings</title>
155+
155156
<para>
156157
By default, recovery will recover to the end of the WAL log. The
157158
following parameters can be used to specify an earlier stopping point.
158159
At most one of <varname>recovery_target</>,
159160
<varname>recovery_target_name</>, <varname>recovery_target_time</>, or
160-
<varname>recovery_target_xid</> can be specified.
161+
<varname>recovery_target_xid</> can be used; if more than one of these
162+
is specified in the configuration file, the last entry will be used.
161163
</para>
162-
<variablelist>
163164

164-
<varlistentry id="recovery-target" xreflabel="recovery_target_name">
165+
<variablelist>
166+
<varlistentry id="recovery-target" xreflabel="recovery_target">
165167
<term><varname>recovery_target</varname><literal> = 'immediate'</literal>
166168
<indexterm>
167169
<primary><varname>recovery_target</> recovery parameter</primary>
@@ -189,8 +191,8 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
189191
</term>
190192
<listitem>
191193
<para>
192-
This parameter specifies the named restore point, created with
193-
<function>pg_create_restore_point()</> to which recovery will proceed.
194+
This parameter specifies the named restore point (created with
195+
<function>pg_create_restore_point()</>) to which recovery will proceed.
194196
</para>
195197
</listitem>
196198
</varlistentry>
@@ -231,13 +233,13 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
231233
</listitem>
232234
</varlistentry>
233235
</variablelist>
236+
234237
<para>
235238
The following options further specify the recovery target, and affect
236239
what happens when the target is reached:
237240
</para>
238241

239242
<variablelist>
240-
241243
<varlistentry id="recovery-target-inclusive"
242244
xreflabel="recovery_target_inclusive">
243245
<term><varname>recovery_target_inclusive</varname> (<type>boolean</type>)
@@ -247,12 +249,12 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
247249
</term>
248250
<listitem>
249251
<para>
250-
Specifies whether we stop just after the specified recovery target
252+
Specifies whether to stop just after the specified recovery target
251253
(<literal>true</literal>), or just before the recovery target
252254
(<literal>false</literal>).
253-
Applies to both <xref linkend="recovery-target-time">
254-
and <xref linkend="recovery-target-xid">, whichever one is
255-
specified for this recovery. This indicates whether transactions
255+
Applies when either <xref linkend="recovery-target-time">
256+
or <xref linkend="recovery-target-xid"> is specified.
257+
This setting controls whether transactions
256258
having exactly the target commit time or ID, respectively, will
257259
be included in the recovery. Default is <literal>true</>.
258260
</para>
@@ -294,10 +296,10 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
294296
This is intended to allow queries to be executed against the
295297
database to check if this recovery target is the most desirable
296298
point for recovery. The paused state can be resumed by using
297-
<function>pg_xlog_replay_resume()</> (See
299+
<function>pg_xlog_replay_resume()</> (see
298300
<xref linkend="functions-recovery-control-table">), which then
299301
causes recovery to end. If this recovery target is not the
300-
desired stopping point, then shutdown the server, change the
302+
desired stopping point, then shut down the server, change the
301303
recovery target settings to a later target and restart to
302304
continue recovery.
303305
</para>

0 commit comments

Comments
 (0)