pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  

help / color / mirror / Atom feed

Move --interactive in createuser.sgml?
2+ messages / 2 participants
[nested] [flat]

* Move --interactive in createuser.sgml?
@ 2023-07-04 07:58 Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
  2023-07-04 09:56 ` Re: Move --interactive in createuser.sgml? Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 1 reply; 2+ messages in thread

From: Ekaterina Kiryanova @ 2023-07-04 07:58 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org

Hello!

I noticed that the --interactive option in createuser.sgml is in the 
list of short options rather than in the list of the long ones later on.
If it makes sense to move it below, the attached patch fixes that for 
master (after --bypassrls/--no-bypassrls).
Please take a look.

-- 
Best regards,
Ekaterina Kiryanova
Technical Writer
Postgres Professional
the Russian PostgreSQL Company

Attachments:

  [text/x-patch] createuser_interactive.patch (1.6K, ../../a7bd4e67-d503-ba4e-c2e4-2f812d413bab@postgrespro.ru/2-createuser_interactive.patch)
  download | inline diff:
diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml
index 5c34c62342..45fe700e85 100644
--- a/doc/src/sgml/ref/createuser.sgml
+++ b/doc/src/sgml/ref/createuser.sgml
@@ -183,20 +183,6 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
-     <varlistentry>
-      <term><option>--interactive</option></term>
-      <listitem>
-       <para>
-        Prompt for the user name if none is specified on the command line, and
-        also prompt for whichever of the options
-        <option>-d</option>/<option>-D</option>,
-        <option>-r</option>/<option>-R</option>,
-        <option>-s</option>/<option>-S</option> is not specified on the command
-        line.  (This was the default behavior up to PostgreSQL 9.1.)
-       </para>
-      </listitem>
-     </varlistentry>
-
      <varlistentry>
       <term><option>-l</option></term>
       <term><option>--login</option></term>
@@ -330,6 +316,20 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
+     <varlistentry>
+      <term><option>--interactive</option></term>
+      <listitem>
+       <para>
+        Prompt for the user name if none is specified on the command line, and
+        also prompt for whichever of the options
+        <option>-d</option>/<option>-D</option>,
+        <option>-r</option>/<option>-R</option>,
+        <option>-s</option>/<option>-S</option> is not specified on the command
+        line.  (This was the default behavior up to PostgreSQL 9.1.)
+       </para>
+      </listitem>
+     </varlistentry>
+
      <varlistentry>
       <term><option>--replication</option></term>
       <listitem>


^ permalink  raw  reply  [nested|flat] 2+ messages in thread

* Re: Move --interactive in createuser.sgml?
  2023-07-04 07:58 Move --interactive in createuser.sgml? Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
@ 2023-07-04 09:56 ` Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 0 replies; 2+ messages in thread

From: Daniel Gustafsson @ 2023-07-04 09:56 UTC (permalink / raw)
  To: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org

> On 4 Jul 2023, at 09:58, Ekaterina Kiryanova <e.kiryanova@postgrespro.ru> wrote:

> I noticed that the --interactive option in createuser.sgml is in the list of short options rather than in the list of the long ones later on.
> If it makes sense to move it below, the attached patch fixes that for master (after --bypassrls/--no-bypassrls).
> Please take a look.

I'm not sure this moves the needle much in terms of consistency in listing
options, and I'm not sure there is policy to follow.  createdb has long options
in alphabetical order, pg_basebackup has long options both by alphabetical and
grouped last, and pg_amcheck groups options by type.

Whether or not an option has a short option as well as a long option is an
implementation detail that I don't think should drive how we present the
information to the users in order to help them find what they need.

--
Daniel Gustafsson






^ permalink  raw  reply  [nested|flat] 2+ messages in thread

end of thread, other threads:[~2023-07-04 09:56 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-07-04 07:58 Move --interactive in createuser.sgml? Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
2023-07-04 09:56 ` Daniel Gustafsson <daniel@yesql.se>

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