Horton

Thread

Commits

  1. doc: Adjust some markups on pg_waldump page

  1. DOCS - pg_waldump synopsis sgml markup

    Peter Smith <smithpb2250@gmail.com> — 2026-02-17T00:38:27Z

    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

  2. Re: DOCS - pg_waldump synopsis sgml markup

    Ashutosh Bapat <ashutosh.bapat.oss@gmail.com> — 2026-02-17T11:49:05Z

    On Tue, Feb 17, 2026 at 6:09 AM 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.

+1. I looked at a few other application document pages and we use
replaceable for replaceable arguments.

-- 
Best Wishes,
Ashutosh Bapat

  3. Re: DOCS - pg_waldump synopsis sgml markup

    Chao Li <li.evan.chao@gmail.com> — 2026-02-24T03:25:13Z

    
> 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/

  4. Re: DOCS - pg_waldump synopsis sgml markup

    Michael Paquier <michael@paquier.xyz> — 2026-02-24T03:56:30Z

    On Tue, Feb 17, 2026 at 05:19:05PM +0530, Ashutosh Bapat wrote:
> +1. I looked at a few other application document pages and we use
> replaceable for replaceable arguments.

Done that, in passing.
--
Michael

  5. Re: DOCS - pg_waldump synopsis sgml markup

    Peter Smith <smithpb2250@gmail.com> — 2026-03-09T02:23:32Z

    Thanks for pushing!

I have marked the corresponding CF entry as "Committed".

======
Kind Regards,
Peter Smith.
Fujitsu Australia.