Improve pg_resetwal documentation

 Clarify that the -l option takes a file name, not an "address", and that
 that might be different from the LSN if nondefault WAL segment sizes are
 used.
 
 

diff --git a/doc/src/sgml/ref/pg_resetwal.sgml b/doc/src/sgml/ref/pg_resetwal.sgml
index 43b58a49e6032b3958ab5823f404b5cc2c807479..34ebe11a4427abfe4327f01cbb6e91c3c7ae9608 100644 (file)
--- a/doc/src/sgml/ref/pg_resetwal.sgml
+++ b/doc/src/sgml/ref/pg_resetwal.sgml
@@ -62,7 +62,7 @@ PostgreSQL documentation
    values will be substituted for the missing data.  Most of the fields can be
    expected to match, but manual assistance might be needed for the next OID,
    next transaction ID and epoch, next multitransaction ID and offset, and
-   WAL starting address fields. These fields can be set using the options
+   WAL starting location fields. These fields can be set using the options
    discussed below. If you are not able to determine correct values for all
    these fields, <option>-f</option> can still be used, but
    the recovered database must be treated with even more suspicion than
@@ -167,11 +167,12 @@ PostgreSQL documentation
     <term><option>-l</option> <replaceable class="parameter">walfile</replaceable></term>
     <listitem>
      <para>
-      Manually set the WAL starting address.
+      Manually set the WAL starting location by specifying the name of the
+      next WAL segment file.
      </para>
 
      <para>
-      The WAL starting address should be
+      The name of next WAL segment file should be
       larger than any WAL segment file name currently existing in
       the directory <filename>pg_wal</filename> under the data directory.
       These names are also in hexadecimal and have three parts.  The first
@@ -180,6 +181,13 @@ PostgreSQL documentation
       largest entry in <filename>pg_wal</filename>, use <literal>-l 00000001000000320000004B</literal> or higher.
      </para>
 
+     <para>
+      Note that when using nondefault WAL segment sizes, the numbers in the WAL
+      file names are different from the LSNs that are reported by system
+      functions and system views.  This option takes a WAL file name, not an
+      LSN.
+     </para>
+
      <note>
       <para>
        <command>pg_resetwal</command> itself looks at the files in