Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 1c15f84

Browse files
committed
pg_xlogdump: document --path behavior
The previous --path documentation and --help output were wrong in both its meaning and the defaults. Reviewed-by: Michael Paquier Backpatch-through: 9.6
1 parent 22a85b3 commit 1c15f84

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

doc/src/sgml/ref/pg_xlogdump.sgml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,12 @@ PostgreSQL documentation
117117
<term><option>--path=<replaceable>path</replaceable></option></term>
118118
<listitem>
119119
<para>
120-
Directory in which to find log segment files. The default is to search
121-
for them in the <literal>pg_xlog</literal> subdirectory of the current
122-
directory.
120+
Specifies a directory to search for log segment files or a
121+
directory with a <literal>pg_xlog</literal> subdirectory that
122+
contains such files. The default is to search in the current
123+
directory, the <literal>pg_xlog</literal> subdirectory of the
124+
current directory, and the <literal>pg_xlog</literal> subdirectory
125+
of <envar>PGDATA</envar>.
123126
</para>
124127
</listitem>
125128
</varlistentry>

src/bin/pg_xlogdump/pg_xlogdump.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -679,8 +679,9 @@ usage(void)
679679
printf(" -e, --end=RECPTR stop reading at log position RECPTR\n");
680680
printf(" -f, --follow keep retrying after reaching end of WAL\n");
681681
printf(" -n, --limit=N number of records to display\n");
682-
printf(" -p, --path=PATH directory in which to find log segment files\n");
683-
printf(" (default: ./pg_xlog)\n");
682+
printf(" -p, --path=PATH directory in which to find log segment files or a\n");
683+
printf(" directory with a ./pg_xlog that contains such files\n"
684+
" (default: current directory, ./pg_xlog, PGDATA/pg_xlog)\n");
684685
printf(" -r, --rmgr=RMGR only show records generated by resource manager RMGR\n");
685686
printf(" use --rmgr=list to list valid resource manager names\n");
686687
printf(" -s, --start=RECPTR start reading at log position RECPTR\n");

0 commit comments

Comments
 (0)