Improve recovery target settings documentation.

Commit 815d71dee 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.

diff --git a/doc/src/sgml/recovery-config.sgml b/doc/src/sgml/recovery-config.sgml
index 31473cdf35b1953509c98e5aa98119419716c295..ef78bc05114efca797cd8578882230c5a90838cb 100644 (file)
--- a/doc/src/sgml/recovery-config.sgml
+++ b/doc/src/sgml/recovery-config.sgml
@@ -152,16 +152,18 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
   
 
     Recovery Target Settings
+
      
       By default, recovery will recover to the end of the WAL log. The
       following parameters can be used to specify an earlier stopping point.
       At most one of recovery_target,
       recovery_target_name, recovery_target_time, or
-      recovery_target_xid can be specified.
+      recovery_target_xid can be used; if more than one of these
+      is specified in the configuration file, the last entry will be used.
      
-     
 
-     
+     
+     
       recovery_target = 'immediate'
       
         recovery_target recovery parameter
@@ -189,8 +191,8 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
       
       
        
-        This parameter specifies the named restore point, created with
-        pg_create_restore_point() to which recovery will proceed.
+        This parameter specifies the named restore point (created with
+        pg_create_restore_point()) to which recovery will proceed.
        
       
      
@@ -231,13 +233,13 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
       
      
      
+
      
        The following options further specify the recovery target, and affect
        what happens when the target is reached:
      
 
      
-
      
                    xreflabel="recovery_target_inclusive">
       recovery_target_inclusive (boolean)
@@ -247,12 +249,12 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
       
       
        
-        Specifies whether we stop just after the specified recovery target
+        Specifies whether to stop just after the specified recovery target
         (true), or just before the recovery target
         (false).
-        Applies to both 
-        and , whichever one is
-        specified for this recovery.  This indicates whether transactions
+        Applies when either 
+        or  is specified.
+        This setting controls whether transactions
         having exactly the target commit time or ID, respectively, will
         be included in the recovery.  Default is true.
        
@@ -280,27 +282,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
       
      
 
-     
-                   xreflabel="pause_at_recovery_target">
-      pause_at_recovery_target (boolean)
-      
-        pause_at_recovery_target recovery parameter
-      
-      
-      
-       
-        Alias for recovery_target_action, true is same as
-        recovery_target_action = pause and false
-        is same as recovery_target_action = promote.
-       
-       
-        This setting has no effect if  is not
-        enabled, or if no recovery target is set.
-       
-      
-     
-
-     
+     
                    xreflabel="recovery_target_action">
       recovery_target_action (enum)
       
@@ -311,35 +293,35 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
        
         Specifies what action the server should take once the recovery target is
         reached. The default is pause, which means recovery will
-        be paused. promote means recovery process will finish and
-        the server will start to accept connections.
+        be paused. promote means the recovery process will finish
+        and the server will start to accept connections.
         Finally shutdown will stop the server after reaching the
         recovery target.
        
        
-        The intended use of pause setting is to allow queries to be
-        executed against the database to check if this recovery target is the
-        most desirable point for recovery. The paused state can be resumed by
-        using pg_xlog_replay_resume() (See
+        The intended use of the pause setting is to allow queries
+        to be executed against the database to check if this recovery target
+        is the most desirable point for recovery.
+        The paused state can be resumed by
+        using pg_xlog_replay_resume() (see
         ), which then
         causes recovery to end. If this recovery target is not the
-        desired stopping point, then shutdown the server, change the
+        desired stopping point, then shut down the server, change the
         recovery target settings to a later target and restart to
         continue recovery.
        
        
-        The shutdown setting is useful to have instance ready at
-        exact replay point desired.
-        The instance will still be able to replay more WAL records (and in fact
-        will have to replay WAL records since last checkpoint next time it is
-        started).
+        The shutdown setting is useful to have the instance ready
+        at the exact replay point desired.  The instance will still be able to
+        replay more WAL records (and in fact will have to replay WAL records
+        since the last checkpoint next time it is started).
        
        
         Note that because recovery.conf will not be renamed when
         recovery_target_action is set to shutdown,
         any subsequent start will end with immediate shutdown unless the
-        configuration is changed or the recovery.conf is removed
-        manually.
+        configuration is changed or the recovery.conf file is
+        removed manually.
        
        
         This setting has no effect if no recovery target is set.
@@ -349,6 +331,28 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
       
      
 
+     
+                   xreflabel="pause_at_recovery_target">
+      pause_at_recovery_target (boolean)
+      
+        pause_at_recovery_target recovery parameter
+      
+      
+      
+       
+        This is an obsolete version of recovery_target_action.
+        Setting it to true is the same as
+        recovery_target_action = pause,
+        while false is the same as
+        recovery_target_action = promote.
+       
+       
+        This setting has no effect if  is not
+        enabled, or if no recovery target is set.
+       
+      
+     
+
      
    
 




This is the main PostgreSQL git repository.
RSS
Atom



window.onload = function () {
	var tz_cookie = { name: 'gitweb_tz', expires: 14, path: '/' };
	onloadTZSetup('local', tz_cookie, 'datetime');
};