| From: | Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> |
|---|---|
| To: | Peter Smith <smithpb2250(at)gmail(dot)com> |
| Cc: | PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org> |
| Subject: | Re: DOCS - pg_waldump synopsis sgml markup |
| Date: | 2026-02-24 03:25:13 |
| Message-ID: | 397E7B41-35FC-4E58-AFF2-5685D1E29186@gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
> On Feb 17, 2026, at 08:38, Peter Smith <smithpb2250(at)gmail(dot)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/
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Bryan Green | 2026-02-24 03:36:31 | Re: [PATCH] Add Windows support for backtrace_functions (MSVC only) |
| Previous Message | Tender Wang | 2026-02-24 03:12:20 | Re: MERGE behavior with REPEATABLE READ isolation level |