Document deprecated --wal-directory option for pg_verifybackup

Commit b3cf461b3cf renamed --wal-directory to --wal-path but retained
the former as a silent alias.  Per project policy, all options,
including deprecated ones, should be documented to assist users
transitioning between versions.

This patch restores --wal-directory to the documentation and --help
output.

Author: Amul Sul <sulamul@gmail.com>
Discussion: https://www.postgresql.org/message-id/flat/E1w3fZp-000gje-31%40gemulon.postgresql.org

diff --git a/doc/src/sgml/ref/pg_verifybackup.sgml b/doc/src/sgml/ref/pg_verifybackup.sgml
index 1695cfe91c8bd58d55d53a7b92ab24253ca88036..045516464a48918dda74530cbb5fbbc7030fb674 100644 (file)
--- a/doc/src/sgml/ref/pg_verifybackup.sgml
+++ b/doc/src/sgml/ref/pg_verifybackup.sgml
@@ -259,6 +259,7 @@ PostgreSQL documentation
      <varlistentry>
       <term><option>-w <replaceable class="parameter">path</replaceable></option></term>
       <term><option>--wal-path=<replaceable class="parameter">path</replaceable></option></term>
+      <term><option>--wal-directory=<replaceable class="parameter">path</replaceable></option> (deprecated)</term>
       <listitem>
        <para>
         Try to parse WAL files stored in the specified directory or tar

diff --git a/src/bin/pg_verifybackup/pg_verifybackup.c b/src/bin/pg_verifybackup/pg_verifybackup.c
index b60ab8739d5f1ef258517806bd4ed63a8e0a08cd..bb4fb97219ee9d04ab96cd61a9a365cc2649b38e 100644 (file)
--- a/src/bin/pg_verifybackup/pg_verifybackup.c
+++ b/src/bin/pg_verifybackup/pg_verifybackup.c
@@ -1399,6 +1399,7 @@ usage(void)
        printf(_("  -q, --quiet                 do not print any output, except for errors\n"));
        printf(_("  -s, --skip-checksums        skip checksum verification\n"));
        printf(_("  -w, --wal-path=PATH         use specified path for WAL files\n"));
+       printf(_("      --wal-directory=PATH    (same as --wal-path, deprecated)\n"));
        printf(_("  -V, --version               output version information, then exit\n"));
        printf(_("  -?, --help                  show this help, then exit\n"));
        printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);