Patch: Make pg_waldump.sgml less confusing
The pg_waldump manpage says the --save-fullpage output format was
TIMELINE-LSN.RELTABLESPACE.DATOID.RELNODE.BLKNOFORK
when the filenames actually have the format
00000001-00000000-309A88C0.1663.5.64080.0_main
with an underscore in front of FORK.
While that is technically correct because it then explains that
FORK is something like "_main", I think this is just confusing and
moving the underscore into the file name format description is much
cleaner. (And inside the rest of the code, the fork names don't have
underscore prefixes either.)
Christoph
Attachments:
0001-pg_waldump.sgml-Put-underscore-in-front-of-FORK.patchtext/x-diff; charset=us-asciiDownload
From f4315196cd651e092edddd21ba283034e54d6fde Mon Sep 17 00:00:00 2001
From: Christoph Berg <myon@debian.org>
Date: Tue, 1 Oct 2024 23:36:22 +0200
Subject: [PATCH] pg_waldump.sgml: Put underscore in front of FORK
Instead of including the leading underscore in the FORK name, put the
underscore into the file name format definition where it is less
confusing.
---
doc/src/sgml/ref/pg_waldump.sgml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml
index a9371e037b..ce23add557 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>
--
2.45.2
On Tue, Oct 01, 2024 at 11:44:40PM +0200, Christoph Berg wrote:
While that is technically correct because it then explains that
FORK is something like "_main", I think this is just confusing and
moving the underscore into the file name format description is much
cleaner. (And inside the rest of the code, the fork names don't have
underscore prefixes either.)
Good point. What you are proposing is easier to read. Will fix.
Thanks for the report.
--
Michael