Add a docs section for obsoleted and renamed functions and settings

The new appendix groups information on renamed or removed settings,
commands, etc into an out-of-the-way part of the docs.

The original id elements are retained in each subsection to ensure that
the same filenames are produced for HTML docs. This prevents /current/
links on the web from breaking, and allows users of the web docs
to follow links from old version pages to info on the changes in the
new version. Prior to this change, a link to /current/ for renamed
sections like the recovery.conf docs would just 404. Similarly if
someone searched for recovery.conf they would find the pg11 docs,
but there would be no /12/ or /current/ link, so they couldn't easily
find out that it was removed in pg12 or how to adapt.

Index entries are also added so that there's a breadcrumb trail for
users to follow when they know the old name, but not what we changed it
to. So a user who is trying to find out how to set standby_mode in
PostgreSQL 12+, or where pg_resetxlog went, now has more chance of
finding that information.

Craig Ringer and Stephen Frost
Reviewed-by: Euler Taveira
Discussion: https://postgr.es/m/CAGRY4nzPNOyYQ_1-pWYToUVqQ0ThqP5jdURnJMZPm539fdizOg%40mail.gmail.com
Backpatch-through: 10

diff --git a/doc/src/sgml/appendix-obsolete-pgreceivexlog.sgml b/doc/src/sgml/appendix-obsolete-pgreceivexlog.sgml
new file mode 100644 (file)
index 0000000..f74d0ae
--- /dev/null
+++ b/doc/src/sgml/appendix-obsolete-pgreceivexlog.sgml
@@ -0,0 +1,24 @@
+
+
+
+
+  <command>pg_receivexlog</command> renamed to <command>pg_receivewal</command>
+
+   
+     pg_receivexlog
+     pg_receivewal
+   
+
+   
+    PostgreSQL 9.6 and below provided a command named
+    pg_receivexlog
+    pg_receivexlog
+    to fetch write-ahead-log (WAL) files.  This command was renamed to pg_receivewal, see
+     for documentation of pg_receivewal and see
+    the release notes for PostgreSQL 10 for details
+    on this change.
+   
+
+

diff --git a/doc/src/sgml/appendix-obsolete-pgresetxlog.sgml b/doc/src/sgml/appendix-obsolete-pgresetxlog.sgml
new file mode 100644 (file)
index 0000000..7d99930
--- /dev/null
+++ b/doc/src/sgml/appendix-obsolete-pgresetxlog.sgml
@@ -0,0 +1,24 @@
+
+
+
+
+  <command>pg_resetxlog</command> renamed to <command>pg_resetwal</command>
+
+   
+     pg_resetxlog
+     pg_resetwal
+   
+
+   
+    PostgreSQL 9.6 and below provided a command named
+    pg_resetxlog
+    pg_resetxlog
+    to reset the write-ahead-log (WAL) files.  This command was renamed to pg_resetwal, see
+     for documentation of pg_resetwal and see
+    the release notes for PostgreSQL 10 for details
+    on this change.
+   
+
+

diff --git a/doc/src/sgml/appendix-obsolete-pgxlogdump.sgml b/doc/src/sgml/appendix-obsolete-pgxlogdump.sgml
new file mode 100644 (file)
index 0000000..4173fee
--- /dev/null
+++ b/doc/src/sgml/appendix-obsolete-pgxlogdump.sgml
@@ -0,0 +1,24 @@
+
+
+
+
+  <command>pg_xlogdump</command> renamed to <command>pg_waldump</command>
+
+   
+     pg_xlogdump
+     pg_waldump
+   
+
+   
+    PostgreSQL 9.6 and below provided a command named
+    pg_xlogdump
+    pg_xlogdump
+    to read write-ahead-log (WAL) files.  This command was renamed to pg_waldump, see
+     for documentation of pg_waldump and see
+    the release notes for PostgreSQL 10 for details
+    on this change.
+   
+
+

diff --git a/doc/src/sgml/appendix-obsolete-recovery-config.sgml b/doc/src/sgml/appendix-obsolete-recovery-config.sgml
new file mode 100644 (file)
index 0000000..77c4289
--- /dev/null
+++ b/doc/src/sgml/appendix-obsolete-recovery-config.sgml
@@ -0,0 +1,58 @@
+
+
+
+
+  <filename>recovery.conf</filename> file merged into <filename>postgresql.conf</filename>
+
+   
+     recovery.conf
+   
+
+   
+    PostgreSQL 11 and below used a configuration file named
+    recovery.conf
+    recovery.conf
+    to manage replicas and standbys. Support for this file was removed in PostgreSQL 12. See
+    the release notes for PostgreSQL 12 for details
+    on this change.
+   
+
+   
+    On PostgreSQL 12 and above,
+    archive recovery, streaming replication, and PITR
+    are configured using
+    normal server configuration parameters.
+    These are set in postgresql.conf or via
+    ALTER SYSTEM
+    like any other parameter.
+   
+
+   
+    The server will not start if a recovery.conf exists.
+   
+
+   
+    The
+    trigger_file
+    
+     trigger_file
+     promote_trigger_file
+    
+    setting has been renamed to
+    .
+   
+
+   
+    The
+    standby_mode
+    
+     standby_mode
+     standby.signal
+    
+    setting has been removed. A standby.signal file in the data directory
+    is used instead. See  for details.
+   
+
+

diff --git a/doc/src/sgml/appendix-obsolete.sgml b/doc/src/sgml/appendix-obsolete.sgml
new file mode 100644 (file)
index 0000000..ffd7d40
--- /dev/null
+++ b/doc/src/sgml/appendix-obsolete.sgml
@@ -0,0 +1,41 @@
+
+
+
+ Obsolete or Renamed Features
+
+ 
+   Functionality is sometimes removed from PostgreSQL, feature, setting
+   and file names sometimes change, or documentation moves to different
+   places. This section directs users coming from old versions of the
+   documentation or from external links to the appropriate new location
+   for the information they need.
+ 
+
+ 
+
+ &obsolete-recovery-config;
+ &obsolete-pgxlogdump;
+ &obsolete-pgresetxlog;
+ &obsolete-pgreceivexlog;
+
+

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index da323621b53c758ddd2b169238db525a45d7b445..3cb7d04ef792a27133c526ccddfb906ba48fdf9a 100644 (file)
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4062,8 +4062,9 @@ ANY num_sync ( 
      Standby Servers
 
      
-      These settings control the behavior of a standby server that is
-      to receive replication data.  Their values on the master server
+      These settings control the behavior of a
+      standby server
+      that is to receive replication data.  Their values on the master server
       are irrelevant.
      
 

diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml
index 8960f11278640cff2ec569dbca7347c2c6619cb0..332cb4a7d15fd47dffbaf0e6e6462b21d664bb50 100644 (file)
--- a/doc/src/sgml/filelist.sgml
+++ b/doc/src/sgml/filelist.sgml
@@ -179,3 +179,10 @@
 
 
 
+
+
+
+
+
+
+

diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml
index 07d3982c306ea3b0c31bee5ca6f78a38ebf5abb8..22ac33bda30fc5e57fad5be639a804312db46f83 100644 (file)
--- a/doc/src/sgml/high-availability.sgml
+++ b/doc/src/sgml/high-availability.sgml
@@ -611,9 +611,17 @@ protocol to make nodes agree on a serializable transactional order.
 
   
 
-  
+   xreflabel="Standby Server Operation">
    Standby Server Operation
 
+   
+    A server enters standby mode if a
+    
+    standby.signal
+    standby.signal
+    file exists in the data directory when the server is started.
+   
+
    
     In standby mode, the server continuously applies WAL received from the
     master server. The standby server can read WAL from a WAL archive
@@ -686,7 +694,8 @@ protocol to make nodes agree on a serializable transactional order.
    
     To set up the standby server, restore the base backup taken from primary
     server (see ). Create a file
-    standby.signal in the standby's cluster data
+    standby.signalstandby.signal
+    in the standby's cluster data
     directory. Set  to a simple command to copy files from
     the WAL archive. If you plan to have multiple standby servers for high
     availability purposes, make sure that recovery_target_timeline is set to
@@ -2103,7 +2112,8 @@ if (!triggered)
 
    
     If hot_standby is on in postgresql.conf
-    (the default value) and there is a standby.signal
+    (the default value) and there is a
+    standby.signalstandby.signalfor hot standby
     file present, the server will run in Hot Standby mode.
     However, it may take some time for Hot Standby connections to be allowed,
     because the server will not accept connections until it has completed

diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml
index 3e115f1c76c8c33c3bc57c280d87913baa20602c..25d8f2204b2497220d30900d259131db7d8acaba 100644 (file)
--- a/doc/src/sgml/postgres.sgml
+++ b/doc/src/sgml/postgres.sgml
@@ -278,6 +278,7 @@
   &docguide;
   &limits;
   &acronyms;
+  &obsolete;
 
  
 

diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index 01dac10257176f82f75b4adfc209004a7b9e0500..fde143c763a956c80ce8a2468d328a3f724acb2a 100644 (file)
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -215,7 +215,9 @@ PostgreSQL documentation
       
 
        
-        Create standby.signal and append connection settings
+        Create standby.signal
+        standby.signalpg_basebackup --write-recovery-conf
+        file and append connection settings
         to postgresql.auto.conf in the output
         directory (or into the base archive file when using tar format) to
         ease setting up a standby server.