Re: DOCS - pg_waldump synopsis sgml markup - Mailing list pgsql-hackers

From Chao Li
Subject Re: DOCS - pg_waldump synopsis sgml markup
Date
Msg-id 397E7B41-35FC-4E58-AFF2-5685D1E29186@gmail.com
Whole thread Raw
In response to DOCS - pg_waldump synopsis sgml markup  (Peter Smith <smithpb2250@gmail.com>)
List pgsql-hackers

> On Feb 17, 2026, at 08:38, Peter Smith <smithpb2250@gmail.com> wrote:
>
> Hi.
>
> I found that the synopsis for pg_waldump is not using correct SGML markup.
>
> The options part and the other startseg/endseg parameters should be
> using <replaceable>, same as for all the other synopses of server
> applications.
>
> PSA patch for the same.
>
> ======
> Kind Regards,
> Peter Smith.
> Fujitsu Australia
> <v1-0001-DOCS-fix-pg_waldump-synopsis-markup.patch>

In my understanding, <option> is used for literal flags that the user types exactly as written, e.g. “-f”;
<replaceable>is used for placeholder text that the user must substitute with a real value. 

So, using <replaceable> for startseg/endseg in this patch looks correct to me.

Best regards,
--
Chao Li (Evan)
HighGo Software Co., Ltd.
https://www.highgo.com/







pgsql-hackers by date:

Previous
From: Tender Wang
Date:
Subject: Re: MERGE behavior with REPEATABLE READ isolation level
Next
From: Bryan Green
Date:
Subject: Re: [PATCH] Add Windows support for backtrace_functions (MSVC only)