Tidy up a few cosmetic issues related to pg_basebackup.
authorRobert Haas <rhaas@postgresql.org>
Tue, 25 Jan 2022 19:54:35 +0000 (14:54 -0500)
committerRobert Haas <rhaas@postgresql.org>
Tue, 25 Jan 2022 19:59:37 +0000 (14:59 -0500)
Commit 0ad8032910d5eb8efd32867c45b6a25c85e60f50 failed to update
the pg_basebackup documentation to mention that "client-" or
"server-" can now be prepended to the compression method name. Fix
it there, and also in the --help output that you get from running
the binary.

Also in the documentation, there's an old issue that the arguments to
--checkpoint shouldn't be marked as parameters, because "fast" and
"spread" are literal strings. Fix that too.

Dagfinn Ilmari MannsÃ¥ker, partly as per a report from
Shinoda Noriyoshi.

Discussion: http://postgr.es/m/PH7PR84MB1885C1CF433057807551172BEE5F9@PH7PR84MB1885.NAMPRD84.PROD.OUTLOOK.COM

doc/src/sgml/ref/pg_basebackup.sgml
src/bin/pg_basebackup/pg_basebackup.c

index 1d0df346b97025e435dc9e6651835e505d740b5d..a5e03d2c663a1ec0c28e192f41f3232bf1a0b528 100644 (file)
@@ -398,9 +398,9 @@ PostgreSQL documentation
 
      <varlistentry>
       <term><option>-Z <replaceable class="parameter">level</replaceable></option></term>
-      <term><option>-Z <replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
+      <term><option>-Z [{client|server}-]<replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
       <term><option>--compress=<replaceable class="parameter">level</replaceable></option></term>
-      <term><option>--compress=[[{<replaceable class="parameter">client|server</replaceable>-}]<replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
+      <term><option>--compress=[{client|server}-]<replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
       <listitem>
        <para>
         Requests compression of the backup. If <literal>client</literal> or
@@ -441,8 +441,8 @@ PostgreSQL documentation
 
     <variablelist>
      <varlistentry>
-      <term><option>-c <replaceable class="parameter">fast|spread</replaceable></option></term>
-      <term><option>--checkpoint=<replaceable class="parameter">fast|spread</replaceable></option></term>
+      <term><option>-c {fast|spread}</option></term>
+      <term><option>--checkpoint={fast|spread}</option></term>
       <listitem>
        <para>
         Sets checkpoint mode to fast (immediate) or spread (the default)
index 72c27c78d054424e7df0b6b859d20af610402d9a..46f6f53e9b9dcf0dfccff3924c4a17606f281cb7 100644 (file)
@@ -391,7 +391,7 @@ usage(void)
        printf(_("  -X, --wal-method=none|fetch|stream\n"
                         "                         include required WAL files with specified method\n"));
        printf(_("  -z, --gzip             compress tar output\n"));
-       printf(_("  -Z, --compress={gzip,none}[:LEVEL] or [LEVEL]\n"
+       printf(_("  -Z, --compress={[{client,server}-]gzip,none}[:LEVEL] or [LEVEL]\n"
                         "                         compress tar output with given compression method or level\n"));
        printf(_("\nGeneral options:\n"));
        printf(_("  -c, --checkpoint=fast|spread\n"