Re: DOCS - Server Applications [option] should be [option...]

From: Peter Smith <smithpb2250(at)gmail(dot)com>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS - Server Applications [option] should be [option...]
Date: 2026-03-16 01:21:00
Message-ID: CAHut+PsWZrBzAR3LsBX7ksUPm_ud4Rf2WAVAQKBX9kN0Q_8YLg@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Tue, Feb 24, 2026 at 1:48 AM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>
> > On 17 Feb 2026, at 02:08, Peter Smith <smithpb2250(at)gmail(dot)com> wrote:
>
> > Make the "option" part consistent in the synopses of all Server Applications:
> >
> > 1. "[option]" should be "[option...]"
>
> Only if the application can take multiple options. pg_controldata can for
> example only take a single parameter so [option] is correct there.
>

You are correct. Thanks for pointing it out.

> > 2. It should be first
>
> Why? I think it makes more sense to list [option...] after required parameters
> just like how pg_upgrade does it. We might not be consistent as is, but I'm
> not sure it's a net improvement to always list it first as opposed to what we
> have.
>

This patch/thread was primarily about #1, which turned out to be
mistaken. The #2 re-ordering part was just done at the same time, but
got it no support

So, I am withdrawing this patch.

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

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Chao Li 2026-03-16 01:36:36 Re: client_connection_check_interval default value
Previous Message Shin Berg 2026-03-16 01:15:24 Re: Inconsistency in owner assignment between INDEX and STATISTICS