From 73f8d7331343cefaaa97a0039421158fc8462c81 Mon Sep 17 00:00:00 2001
From: Bruce Momjian <bruce@momjian.us>
Date: Tue, 10 Jan 2017 22:38:14 -0500
Subject: 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
---
 doc/src/sgml/ref/pg_xlogdump.sgml | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'doc/src')

diff --git a/doc/src/sgml/ref/pg_xlogdump.sgml b/doc/src/sgml/ref/pg_xlogdump.sgml
index cfb6d87259e..078b08e2e6b 100644
--- a/doc/src/sgml/ref/pg_xlogdump.sgml
+++ b/doc/src/sgml/ref/pg_xlogdump.sgml
@@ -117,9 +117,12 @@ PostgreSQL documentation
       <term><option>--path=<replaceable>path</replaceable></option></term>
       <listitem>
        <para>
-        Directory in which to find log segment files.  The default is to search
-        for them in the <literal>pg_wal</literal> subdirectory of the current
-        directory.
+        Specifies a directory to search for log segment files or a
+        directory with a <literal>pg_wal</literal> subdirectory that
+        contains such files.  The default is to search in the current
+        directory, the <literal>pg_wal</literal> subdirectory of the
+        current directory, and the <literal>pg_wal</literal> subdirectory
+        of <envar>PGDATA</envar>.
        </para>
       </listitem>
      </varlistentry>
-- 
cgit v1.2.3