Mention pg_promote() as a method to trigger promotion in documentation.

Previously in the "Standby Server Operation" section, pg_ctl promote and
protmote_trigger_file were documented as a method to trigger standby
promotion, but pg_promote() function not.

This commit also adds parentheses into pg_promote
in some docs to make it clearer that a function is being referred to.

Author: Masahiro Ikeda
Reviewed-by: Michael Paquier, Laurenz Albe, Tom Lane, Fujii Masao
Discussion: https://postgr.es/m/de0068417a9f4046bac693cbcc00bdc9@oss.nttdata.com

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index a71ca624639422b04282dbf3428669be5a20900c..a14df06292b76800827df16784eec813b8a246c1 100644 (file)
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4114,7 +4114,7 @@ ANY num_sync ( 
           Specifies a trigger file whose presence ends recovery in the
           standby.  Even if this value is not set, you can still promote
           the standby using pg_ctl promote or calling
-          pg_promote.
+          pg_promote().
           This parameter can only be set in the postgresql.conf
           file or on the server command line.
          

diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml
index 4659b9ef5dbc1f7b244fc512070bc60566703b67..52e47379cc712c22530e94ca2e7b61913dc51766 100644 (file)
--- a/doc/src/sgml/high-availability.sgml
+++ b/doc/src/sgml/high-availability.sgml
@@ -644,7 +644,8 @@ protocol to make nodes agree on a serializable transactional order.
 
    
     Standby mode is exited and the server switches to normal operation
-    when pg_ctl promote is run or a trigger file is found
+    when pg_ctl promote is run,
+    pg_promote() is called, or a trigger file is found
     (promote_trigger_file). Before failover,
     any WAL immediately available in the archive or in pg_wal will be
     restored, but no attempt is made to connect to the master.
@@ -1470,11 +1471,11 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
 
    
     To trigger failover of a log-shipping standby server, run
-    pg_ctl promote, call pg_promote,
+    pg_ctl promote, call pg_promote(),
     or create a trigger file with the file name and path specified by the
     promote_trigger_file. If you're planning to use
     pg_ctl promote or to call
-    pg_promote to fail over,
+    pg_promote() to fail over,
     promote_trigger_file is not required. If you're
     setting up the reporting servers that are only used to offload read-only
     queries from the primary, not for high availability purposes, you don't