Change explanation of pg_switch_xlog()'s return value to match code.
authorHeikki Linnakangas <[email protected]>
Thu, 15 Jan 2009 18:23:53 +0000 (18:23 +0000)
committerHeikki Linnakangas <[email protected]>
Thu, 15 Jan 2009 18:23:53 +0000 (18:23 +0000)
doc/src/sgml/func.sgml

index 03d19db1a88faff81843d5ec22633a5c662f1220..98dd41a739de51cec78b6985842aff271b5e6482 100644 (file)
@@ -10295,10 +10295,10 @@ postgres=# select pg_start_backup('label_goes_here');
    <para>
     <function>pg_switch_xlog</> moves to the next transaction log file, allowing the 
     current file to be archived (assuming you are using continuous archiving).
-    The result is the ending transaction log location within the just-completed transaction log file.
+    The result is the ending transaction log location + 1 within the just-completed transaction log file.
     If there has been no transaction log activity since the last transaction log switch,
-    <function>pg_switch_xlog</> does nothing and returns the end location
-    of the previous transaction log file.
+    <function>pg_switch_xlog</> does nothing and returns the start location
+    of the transaction log file currently in use.
    </para>
 
    <para>