Improve recovery.conf.sample comments.

robertmhaas · robertmhaas · commit a9f72b408325 · 2011-01-07T11:01:25.000-05:00
Jehan-Guillaume de Rorthais, with some additional wordsmithing by me.
diff --git a/src/backend/access/transam/recovery.conf.sample b/src/backend/access/transam/recovery.conf.sample
@@ -3,8 +3,8 @@
 # -------------------------------
 #
 # Edit this file to provide the parameters that PostgreSQL needs to
-# perform an archive recovery of a database, or to act as a log-streaming
-# replication standby.
+# perform an archive recovery of a database, or to act as a replication
+# standby.
 #
 # If "recovery.conf" is present in the PostgreSQL data directory, it is
 # read on postmaster startup.  After successful recovery, it is renamed
@@ -88,21 +88,27 @@
 # STANDBY SERVER PARAMETERS
 #---------------------------------------------------------------------------
 #
-# When standby_mode is enabled, the PostgreSQL server will work as
-# a standby. It tries to connect to the primary according to the
-# connection settings primary_conninfo, and receives XLOG records
-# continuously.
+# standby_mode
+#
+# When standby_mode is enabled, the PostgreSQL server will work as a
+# standby. It will continuously wait for the additional XLOG records, using
+# restore_command and/or primary_conninfo.
 #
 #standby_mode = off
 #
+# primary_conninfo
+#
+# If set, the PostgreSQL server will try to connect to the primary using this
+# connection string and receive XLOG records continuously.
+#
 #primary_conninfo = ''		# e.g. 'host=localhost port=5432'
 #
 #
-# By default, a standby server keeps streaming XLOG records from the
-# primary indefinitely. If you want to stop streaming and finish recovery,
-# opening up the system in read/write mode, specify path to a trigger file.
-# Server will poll the trigger file path periodically and stop streaming
-# when it's found.
+# By default, a standby server keeps restoring XLOG records from the
+# primary indefinitely. If you want to stop the standby mode, finish recovery
+# and open the system in read/write mode, specify path to a trigger file.
+# The server will poll the trigger file path periodically and start as a
+# primary server when it's found.
 #
 #trigger_file = ''
 #

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@`
`3`	`3`	`# -------------------------------`
`4`	`4`	`#`
`5`	`5`	`# Edit this file to provide the parameters that PostgreSQL needs to`
`6`		`-# perform an archive recovery of a database, or to act as a log-streaming`
`7`		`-# replication standby.`
	`6`	`+# perform an archive recovery of a database, or to act as a replication`
	`7`	`+# standby.`
`8`	`8`	`#`
`9`	`9`	`# If "recovery.conf" is present in the PostgreSQL data directory, it is`
`10`	`10`	`# read on postmaster startup. After successful recovery, it is renamed`
`@@ -88,21 +88,27 @@`
`88`	`88`	`# STANDBY SERVER PARAMETERS`
`89`	`89`	`#---------------------------------------------------------------------------`
`90`	`90`	`#`
`91`		`-# When standby_mode is enabled, the PostgreSQL server will work as`
`92`		`-# a standby. It tries to connect to the primary according to the`
`93`		`-# connection settings primary_conninfo, and receives XLOG records`
`94`		`-# continuously.`
	`91`	`+# standby_mode`
	`92`	`+#`
	`93`	`+# When standby_mode is enabled, the PostgreSQL server will work as a`
	`94`	`+# standby. It will continuously wait for the additional XLOG records, using`
	`95`	`+# restore_command and/or primary_conninfo.`
`95`	`96`	`#`
`96`	`97`	`#standby_mode = off`
`97`	`98`	`#`
	`99`	`+# primary_conninfo`
	`100`	`+#`
	`101`	`+# If set, the PostgreSQL server will try to connect to the primary using this`
	`102`	`+# connection string and receive XLOG records continuously.`
	`103`	`+#`
`98`	`104`	`#primary_conninfo = '' # e.g. 'host=localhost port=5432'`
`99`	`105`	`#`
`100`	`106`	`#`
`101`		`-# By default, a standby server keeps streaming XLOG records from the`
`102`		`-# primary indefinitely. If you want to stop streaming and finish recovery,`
`103`		`-# opening up the system in read/write mode, specify path to a trigger file.`
`104`		`-# Server will poll the trigger file path periodically and stop streaming`
`105`		`-# when it's found.`
	`107`	`+# By default, a standby server keeps restoring XLOG records from the`
	`108`	`+# primary indefinitely. If you want to stop the standby mode, finish recovery`
	`109`	`+# and open the system in read/write mode, specify path to a trigger file.`
	`110`	`+# The server will poll the trigger file path periodically and start as a`
	`111`	`+# primary server when it's found.`
`106`	`112`	`#`
`107`	`113`	`#trigger_file = ''`
`108`	`114`	`#`