aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorFujii Masao <fujii@postgresql.org>2016-08-06 03:23:41 +0900
committerFujii Masao <fujii@postgresql.org>2016-08-06 03:23:41 +0900
commitb07058c213725e9493052ffe0a219323f74e8ed3 (patch)
tree12da7dd1030c2b6d13cdbfac5bfc73a1cdac5e13 /doc/src
parent3fddd64846ae01886b48c6f4675a5ba93a612fe0 (diff)
downloadpostgresql-b07058c213725e9493052ffe0a219323f74e8ed3.tar.gz
postgresql-b07058c213725e9493052ffe0a219323f74e8ed3.zip
Add note about unused arguments for pg_replication_origin_xact_reset() in docs.
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
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/func.sgml8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index d6ed0ce7a68..7a44a03fb63 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -17519,7 +17519,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
<indexterm>
<primary>pg_replication_origin_xact_reset</primary>
</indexterm>
- <literal><function>pg_replication_origin_xact_reset()</function></literal>
+ <literal><function>pg_replication_origin_xact_reset(<parameter>origin_lsn</parameter> <type>pg_lsn</type>, <parameter>origin_timestamp</parameter> <type>timestamptz</type>)</function></literal>
</entry>
<entry>
void
@@ -17527,6 +17527,12 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
<entry>
Cancel the effects of
<function>pg_replication_origin_xact_setup()</function>.
+ Note that two arguments were introduced <emphasis>by mistake</>
+ during the <productname>PostgreSQL</> 9.5 development cycle while
+ <function>pg_replication_origin_xact_reset()</function> actually
+ doesn't use them at all. Therefore, any dummy values except
+ <literal>NULL</> can be safely specified as the arguments.
+ This mistake will be fixed in a future release.
</entry>
</row>