From: Michael Paquier <michael@paquier.xyz>
Date: Wed, 2 Oct 2024 02:12:45 +0000 (+0900)
Subject: doc: Clarify name of files generated by pg_waldump --save-fullpage
X-Git-Tag: REL_17_1~83
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=97dccefc3651902f3dfad504a39be9a896279bac;p=thirdparty%2Fpostgresql.git

doc: Clarify name of files generated by pg_waldump --save-fullpage

The fork name is always separated with the block number by an underscore
in the names of the files generated, but the docs stuck them together
without a separator, which was confusing.

Author: Christoph Berg
Discussion: https://postgr.es/m/ZvxtSLiix9eceMRM@msg.df7cb.de
Backpatch-through: 16
---

diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml
index a9371e037bd..ce23add5577 100644
--- a/doc/src/sgml/ref/pg_waldump.sgml
+++ b/doc/src/sgml/ref/pg_waldump.sgml
@@ -284,7 +284,7 @@ PostgreSQL documentation
        </para>
        <para>
         The full page images are saved with the following file name format:
-        <literal><replaceable>TIMELINE</replaceable>-<replaceable>LSN</replaceable>.<replaceable>RELTABLESPACE</replaceable>.<replaceable>DATOID</replaceable>.<replaceable>RELNODE</replaceable>.<replaceable>BLKNO</replaceable><replaceable>FORK</replaceable></literal>
+        <literal><replaceable>TIMELINE</replaceable>-<replaceable>LSN</replaceable>.<replaceable>RELTABLESPACE</replaceable>.<replaceable>DATOID</replaceable>.<replaceable>RELNODE</replaceable>.<replaceable>BLKNO</replaceable>_<replaceable>FORK</replaceable></literal>
 
         The file names are composed of the following parts:
         <informaltable>
@@ -335,8 +335,8 @@ PostgreSQL documentation
             <entry>FORK</entry>
             <entry>
              The name of the fork the full page image came from, such as
-             <literal>_main</literal>, <literal>_fsm</literal>,
-             <literal>_vm</literal>, or <literal>_init</literal>.
+             <literal>main</literal>, <literal>fsm</literal>,
+             <literal>vm</literal>, or <literal>init</literal>.
             </entry>
            </row>
           </tbody>