postgres.git / summary / log / commit / refs
commit 9a5da12aba42dbb75efd876ca245e54cebd64ec2
Author: David Rowley <drowley@postgresql.org>
Date: Tue Apr 22 02:57:25 2025 +0000
First released in: 18.0, 13.21, 14.18, 15.13, 16.9, 17.5
Doc: reword text explaining the --maintenance-db option
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 | 5 ++---
doc/src/sgml/ref/reindexdb.sgml | 5 ++---
doc/src/sgml/ref/vacuumdb.sgml | 5 ++---
3 files changed, 6 insertions(+), 9 deletions(-)
diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml
index c838b22c440..b81bc2dc48e 100644
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
@@ -249,9 +249,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 8cb8bf4fa39..5ce1c581650 100644
--- a/doc/src/sgml/ref/reindexdb.sgml
+++ b/doc/src/sgml/ref/reindexdb.sgml
@@ -361,9 +361,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 956c0f01cbc..97f47d3cc9f 100644
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -508,9 +508,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
[parent: 91168a9ae38d]