public inbox for [email protected]  

help / color / mirror / Atom feed

From: Peter Smith <[email protected]>
To: Daniel Gustafsson <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Subject: Re: DOCS - Server Applications [option] should be [option...]
Date: Mon, 16 Mar 2026 12:21:00 +1100
Message-ID: <CAHut+PsWZrBzAR3LsBX7ksUPm_ud4Rf2WAVAQKBX9kN0Q_8YLg@mail.gmail.com> (raw)
In-Reply-To: <[email protected]>
References: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@mail.gmail.com>
	<[email protected]>

On Tue, Feb 24, 2026 at 1:48 AM Daniel Gustafsson <[email protected]> wrote:
>
> > On 17 Feb 2026, at 02:08, Peter Smith <[email protected]> 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

view thread (2+ messages)

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: DOCS - Server Applications [option] should be [option...]
  In-Reply-To: <CAHut+PsWZrBzAR3LsBX7ksUPm_ud4Rf2WAVAQKBX9kN0Q_8YLg@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox