Fix pg_waldump documentation about block option

Started by Japin Lialmost 4 years ago2 messages

japinli@hotmail.com

almost 4 years ago

1 attachment(s)

Hi,

When I read the documentation of pg_waldump, I found the description about
-B option is wrong.

-B block
--block=block
Only display records that modify the given block. The relation must also be provided with --relation or -l.

Before 52b5568, the -l option is short for --relation, however, it has been
changed to -R, and we forgot to update the documentation.

Here is a patch for it.

--
Regrads,
Japin Li.
ChengDu WenWu Information Technology Co.,Ltd.

Attachments:

fix-pg_waldump-documention.patchtext/x-patchDownload

diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml
index 4e86f44c5b..1a05af5d97 100644
--- a/doc/src/sgml/ref/pg_waldump.sgml
+++ b/doc/src/sgml/ref/pg_waldump.sgml
@@ -85,7 +85,7 @@ PostgreSQL documentation
        <para>
         Only display records that modify the given block.  The relation must
         also be provided with <option>--relation</option> or
-        <option>-l</option>.
+        <option>-R</option>.
        </para>
       </listitem>
      </varlistentry>

Thomas Munro

thomas.munro@gmail.com

almost 4 years ago

In reply to: Japin Li (#1)

Re: Fix pg_waldump documentation about block option

On Mon, Mar 28, 2022 at 4:02 PM Japin Li <japinli@hotmail.com> wrote:

Before 52b5568, the -l option is short for --relation, however, it has been
changed to -R, and we forgot to update the documentation.

Here is a patch for it.

Pushed. Thanks!