projects / postgresql.git / commitdiff
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 02c63f9)
Doc: reword text explaining the --maintenance-db option
authorDavid Rowley <drowley@postgresql.org>
Tue, 22 Apr 2025 02:54:22 +0000 (14:54 +1200)
committerDavid Rowley <drowley@postgresql.org>
Tue, 22 Apr 2025 02:54:22 +0000 (14:54 +1200)
The previous text was a little clumsy.  Here we improve that.

Author: David Rowley <dgrowleyml@gmail.com>
Reported-by: Noboru Saito <noborusai@gmail.com>
Reviewed-by: David G. Johnston <david.g.johnston@gmail.com>
Discussion: https://postgr.es/m/CAAM3qnJtv5YbjpwDfVOYN2gZ9zGSLFM1UGJgptSXmwfifOZJFQ@mail.gmail.com
Backpatch-through: 13

doc/src/sgml/ref/clusterdb.sgml patch | blob | blame | history
doc/src/sgml/ref/reindexdb.sgml patch | blob | blame | history
doc/src/sgml/ref/vacuumdb.sgml patch | blob | blame | history

diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml
index d3145318b361fb506c2f2a9739ad6309da3c8bb2..0d2051bf6f1880fd445af48bb27934748e7f8d0b 100644 (file)
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
@@ -248,9 +248,8 @@ PostgreSQL documentation
       <term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term>
       <listitem>
        <para>
-        Specifies the name of the database to connect to to discover which
-        databases should be clustered,
-        when <option>-a</option>/<option>--all</option> is used.
+        When the <option>-a</option>/<option>--all</option> is used, connect
+        to this database to gather the list of databases to cluster.
         If not specified, the <literal>postgres</literal> database will be used,
         or if that does not exist, <literal>template1</literal> will be used.
         This can be a <link linkend="libpq-connstring">connection
diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml
index 98c3333228fb9d5bcb8abb0845066c1c83f85501..abcb041179bb9dd37f6e817f0d077b5f609aa1d4 100644 (file)
--- a/doc/src/sgml/ref/reindexdb.sgml
+++ b/doc/src/sgml/ref/reindexdb.sgml
@@ -352,9 +352,8 @@ PostgreSQL documentation
       <term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term>
       <listitem>
        <para>
-        Specifies the name of the database to connect to to discover which
-        databases should be reindexed,
-        when <option>-a</option>/<option>--all</option> is used.
+        When the <option>-a</option>/<option>--all</option> is used, connect
+        to this database to gather the list of databases to reindex.
         If not specified, the <literal>postgres</literal> database will be used,
         or if that does not exist, <literal>template1</literal> will be used.
         This can be a <link linkend="libpq-connstring">connection
diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
index d102f9d48406c18512197989d643db6b9df8920b..b0680a61814cc9930535d78c87a4957dd6719266 100644 (file)
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -560,9 +560,8 @@ PostgreSQL documentation
       <term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term>
       <listitem>
        <para>
-        Specifies the name of the database to connect to to discover which
-        databases should be vacuumed,
-        when <option>-a</option>/<option>--all</option> is used.
+        When the <option>-a</option>/<option>--all</option> is used, connect
+        to this database to gather the list of databases to vacuum.
         If not specified, the <literal>postgres</literal> database will be used,
         or if that does not exist, <literal>template1</literal> will be used.
         This can be a <link linkend="libpq-connstring">connection
This is the main PostgreSQL git repository.