Doc: improve documentation about postgresql.auto.conf.
authorTom Lane
Thu, 15 Aug 2019 15:14:26 +0000 (11:14 -0400)
committerTom Lane
Thu, 15 Aug 2019 15:14:26 +0000 (11:14 -0400)
Clarify what external tools can do to this file, and add a bit
of detail about what ALTER SYSTEM itself does.

Discussion: https://postgr.es/m/aed6cc9f-98f3-2693-ac81-52bb0052307e@2ndquadrant.com

doc/src/sgml/config.sgml

index 1143dada0ab9c31e4a42f0f5982d428d66371267..b24589f5b75ba6c2f145a13e45e41dec7f87f735 100644 (file)
@@ -136,6 +136,8 @@ shared_buffers = 128MB
      identifiers or numbers must be single-quoted.  To embed a single
      quote in a parameter value, write either two quotes (preferred)
      or backslash-quote.
+     If the file contains multiple entries for the same parameter,
+     all but the last one are ignored.
     
 
     
@@ -165,15 +167,26 @@ shared_buffers = 128MB
     
 
     
-     In addition to postgresql.conf,
+     In addition to postgresql.conffilename>,
      a PostgreSQL data directory contains a file
-     postgresql.auto.confpostgresql.auto.conf,
-     which has the same format as postgresql.conf but should
-     never be edited manually.  This file holds settings provided through
-     the  command.  This file is automatically
-     read whenever postgresql.conf is, and its settings take
-     effect in the same way.  Settings in postgresql.auto.conf
-     override those in postgresql.conf.
+     postgresql.auto.confpostgresql.auto.conf,
+     which has the same format as postgresql.conf but
+     is intended to be edited automatically not manually.  This file holds
+     settings provided through the  command.
+     This file is read whenever postgresql.conf is,
+     and its settings take effect in the same way.  Settings
+     in postgresql.auto.conf override those
+     in postgresql.conf.
+    
+
+    
+     External tools may also
+     modify postgresql.auto.conf.  It is not
+     recommended to do this while the server is running, since a
+     concurrent ALTER SYSTEM command could overwrite
+     such changes.  Such tools might simply append new settings to the end,
+     or they might choose to remove duplicate settings and/or comments
+     (as ALTER SYSTEM will).