Add note about unused arguments for pg_replication_origin_xact_reset() in docs.
authorFujii Masao
Fri, 5 Aug 2016 18:23:41 +0000 (03:23 +0900)
committerFujii Masao
Fri, 5 Aug 2016 18:23:41 +0000 (03:23 +0900)
In 9.5, two arguments were introduced into pg_replication_origin_xact_reset()
by mistake while they are actually not used at all. We cannot fix this issue
for 9.5 anymore because it needs a catalog version bump. Instead, we add
a note about those unused arguments into the document.

Reviewed-By: Andres Freund
doc/src/sgml/func.sgml

index d6ed0ce7a68b4805d4d533343d700f8752688a24..7a44a03fb634806d6475c30e9c6fa96fd348fdc0 100644 (file)
@@ -17519,7 +17519,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
         
          pg_replication_origin_xact_reset
         
-        pg_replication_origin_xact_reset()
+        pg_replication_origin_xact_reset(origin_lsn pg_lsnorigin_timestamp timestamptz)
        
        
         void
@@ -17527,6 +17527,12 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
        
         Cancel the effects of
         pg_replication_origin_xact_setup().
+        Note that two arguments were introduced by mistake
+        during the PostgreSQL 9.5 development cycle while
+        pg_replication_origin_xact_reset() actually
+        doesn't use them at all. Therefore, any dummy values except
+        NULL can be safely specified as the arguments.
+        This mistake will be fixed in a future release.