From: Christoph Berg <myon@debian.org>
To: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Cc: Michael Paquier <michael@paquier.xyz>
Cc: David Christensen <david.christensen@crunchydata.com>
Subject: Patch: Make pg_waldump.sgml less confusing
Date: Tue, 1 Oct 2024 23:44:40 +0200
Message-ID: <ZvxtSLiix9eceMRM@msg.df7cb.de> (raw)
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.patch (text/x-diff, 1.9K) download
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.sgmlindex 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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-hackers@postgresql.org
Cc: myon@debian.org, pgsql-hackers@lists.postgresql.org, michael@paquier.xyz, david.christensen@crunchydata.com
Subject: Re: Patch: Make pg_waldump.sgml less confusing
In-Reply-To: <ZvxtSLiix9eceMRM@msg.df7cb.de>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox