public inbox for [email protected]  
help / color / mirror / Atom feed
From: Peter Smith <[email protected]>
To: PostgreSQL Hackers <[email protected]>
Subject: DOCS - Server Applications [option] should be [option...]
Date: Tue, 17 Feb 2026 12:08:22 +1100
Message-ID: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@mail.gmail.com> (raw)

Hi.

Make the "option" part consistent in the synopses of all Server Applications:

1. "[option]" should be "[option...]"
2. It should be first

PSA patch for the same.

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


Attachments:

  [application/octet-stream] v1-0001-DOCS-option-should-be-first-and-have-ellipsis.patch (2.7K, 2-v1-0001-DOCS-option-should-be-first-and-have-ellipsis.patch)
  download | inline diff:
From 48706bb46a97b64efda7a88b8b31c755fbae57b3 Mon Sep 17 00:00:00 2001
From: Peter Smith <[email protected]>
Date: Tue, 17 Feb 2026 12:02:45 +1100
Subject: [PATCH v1] DOCS - option should be first and have ellipsis

---
 doc/src/sgml/ref/pg_controldata.sgml | 2 +-
 doc/src/sgml/ref/pg_resetwal.sgml    | 2 +-
 doc/src/sgml/ref/pgupgrade.sgml      | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml
index b47fdca9dfc..0eb0abc48a3 100644
--- a/doc/src/sgml/ref/pg_controldata.sgml
+++ b/doc/src/sgml/ref/pg_controldata.sgml
@@ -22,7 +22,7 @@ PostgreSQL documentation
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_controldata</command>
-   <arg choice="opt"><replaceable class="parameter">option</replaceable></arg>
+   <arg rep="repeat" choice="opt"><replaceable class="parameter">option</replaceable></arg>
    <group choice="opt">
     <group choice="opt">
      <arg choice="plain"><option>-D</option></arg>
diff --git a/doc/src/sgml/ref/pg_resetwal.sgml b/doc/src/sgml/ref/pg_resetwal.sgml
index 41f2b1d480c..b0e9d2a9707 100644
--- a/doc/src/sgml/ref/pg_resetwal.sgml
+++ b/doc/src/sgml/ref/pg_resetwal.sgml
@@ -22,6 +22,7 @@ PostgreSQL documentation
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_resetwal</command>
+   <arg rep="repeat"><replaceable>option</replaceable></arg>
    <group choice="opt">
     <arg choice="plain"><option>-f</option></arg>
     <arg choice="plain"><option>--force</option></arg>
@@ -30,7 +31,6 @@ PostgreSQL documentation
     <arg choice="plain"><option>-n</option></arg>
     <arg choice="plain"><option>--dry-run</option></arg>
    </group>
-   <arg rep="repeat"><replaceable>option</replaceable></arg>
    <group choice="plain">
     <group choice="opt">
      <arg choice="plain"><option>-D</option></arg>
diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml
index 38ca09b423c..42a8272c65f 100644
--- a/doc/src/sgml/ref/pgupgrade.sgml
+++ b/doc/src/sgml/ref/pgupgrade.sgml
@@ -22,6 +22,7 @@ PostgreSQL documentation
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_upgrade</command>
+   <arg rep="repeat"><replaceable>option</replaceable></arg>
    <arg choice="plain"><option>-b</option></arg>
    <arg choice="plain"><replaceable>oldbindir</replaceable></arg>
    <arg choice="opt"><option>-B</option> <replaceable>newbindir</replaceable></arg>
@@ -29,7 +30,6 @@ PostgreSQL documentation
    <arg choice="plain"><replaceable>oldconfigdir</replaceable></arg>
    <arg choice="plain"><option>-D</option></arg>
    <arg choice="plain"><replaceable>newconfigdir</replaceable></arg>
-   <arg rep="repeat"><replaceable>option</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
 
-- 
2.47.3



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]
  Subject: Re: DOCS - Server Applications [option] should be [option...]
  In-Reply-To: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@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