From: Michael Paquier <michael@paquier.xyz>
Date: Mon, 19 Nov 2018 04:20:22 +0000 (+0900)
Subject: Rework documentation of pg_promote
X-Git-Tag: REL_12_BETA1~1204
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=74171f8c12e68408f1fa895fdee36fdc8b0a9f79;p=thirdparty%2Fpostgresql.git

Rework documentation of pg_promote

This clarifies the behavior of how the "wait" flag works, which is
something that the previous version of the documentation failed to do.

Author: Ian Barwick
Discussion: https://postgr.es/m/cbd38450-2295-10a1-1f73-591a692ae0b0@2ndquadrant.com
---

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index edeb3fd07bd..d7302617423 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -19278,14 +19278,16 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup());
         </entry>
        <entry><type>boolean</type></entry>
        <entry>
-        Promotes a physical standby server.  Returns <literal>true</literal>
-        if promotion is successful and <literal>false</literal> otherwise.
-        With <parameter>wait</parameter> set to <literal>true</literal>, the
-        default, the function waits until promotion is completed or
-        <parameter>wait_seconds</parameter> seconds have passed, otherwise the
-        function returns immediately after sending the promotion signal to the
-        postmaster.  This function is restricted to superusers by default, but
-        other users can be granted EXECUTE to run the function.
+        Promotes a physical standby server.  With <parameter>wait</parameter>
+        set to <literal>true</literal> (the default), the function waits until
+        promotion is completed or <parameter>wait_seconds</parameter> seconds
+        have passed, and returns <literal>true</literal> if promotion is
+        successful and <literal>false</literal> otherwise.
+        If <parameter>wait</parameter> is set to <literal>false</literal>, the
+        function returns <literal>true</literal> immediately after sending
+        <literal>SIGUSR1</literal> to the postmaster to trigger the promotion.
+        This function is restricted to superusers by default, but other users
+        can be granted EXECUTE to run the function.
        </entry>
       </row>
       <row>