Skip to content

Commit e1f860f

Browse files
committed
Tidy up a few cosmetic issues related to pg_basebackup.
Commit 0ad8032 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
1 parent f9a74c1 commit e1f860f

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/src/sgml/ref/pg_basebackup.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -398,9 +398,9 @@ PostgreSQL documentation
398398

399399
<varlistentry>
400400
<term><option>-Z <replaceable class="parameter">level</replaceable></option></term>
401-
<term><option>-Z <replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
401+
<term><option>-Z [{client|server}-]<replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
402402
<term><option>--compress=<replaceable class="parameter">level</replaceable></option></term>
403-
<term><option>--compress=[[{<replaceable class="parameter">client|server</replaceable>-}]<replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
403+
<term><option>--compress=[{client|server}-]<replaceable class="parameter">method</replaceable></option>[:<replaceable>level</replaceable>]</term>
404404
<listitem>
405405
<para>
406406
Requests compression of the backup. If <literal>client</literal> or
@@ -441,8 +441,8 @@ PostgreSQL documentation
441441

442442
<variablelist>
443443
<varlistentry>
444-
<term><option>-c <replaceable class="parameter">fast|spread</replaceable></option></term>
445-
<term><option>--checkpoint=<replaceable class="parameter">fast|spread</replaceable></option></term>
444+
<term><option>-c {fast|spread}</option></term>
445+
<term><option>--checkpoint={fast|spread}</option></term>
446446
<listitem>
447447
<para>
448448
Sets checkpoint mode to fast (immediate) or spread (the default)

src/bin/pg_basebackup/pg_basebackup.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ usage(void)
391391
printf(_(" -X, --wal-method=none|fetch|stream\n"
392392
" include required WAL files with specified method\n"));
393393
printf(_(" -z, --gzip compress tar output\n"));
394-
printf(_(" -Z, --compress={gzip,none}[:LEVEL] or [LEVEL]\n"
394+
printf(_(" -Z, --compress={[{client,server}-]gzip,none}[:LEVEL] or [LEVEL]\n"
395395
" compress tar output with given compression method or level\n"));
396396
printf(_("\nGeneral options:\n"));
397397
printf(_(" -c, --checkpoint=fast|spread\n"

0 commit comments

Comments
 (0)