Content-Type: text/plain;
	charset=us-ascii
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3776.700.51.11.2\))
Subject: Re: DOCS - Server Applications [option] should be [option...]
From: Daniel Gustafsson <daniel@yesql.se>
In-Reply-To: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@mail.gmail.com>
Date: Mon, 23 Feb 2026 15:47:57 +0100
Cc: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <18D6F77A-A3FD-4DEE-8C79-D719F56D262F@yesql.se>
References: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@mail.gmail.com>
To: Peter Smith <smithpb2250@gmail.com>
Archived-At: <https://www.postgresql.org/message-id/18D6F77A-A3FD-4DEE-8C79-D719F56D262F%40yesql.se>
Precedence: bulk

> On 17 Feb 2026, at 02:08, Peter Smith <smithpb2250@gmail.com> wrote:

> Make the "option" part consistent in the synopses of all Server =
Applications:
>=20
> 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.

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

--
Daniel Gustafsson