diff options
| author | David Rowley <drowley@postgresql.org> | 2025-04-22 14:58:09 +1200 |
|---|---|---|
| committer | David Rowley <drowley@postgresql.org> | 2025-04-22 14:58:09 +1200 |
| commit | c5ba351864d683597af70877f041b51c3a7154e0 (patch) | |
| tree | 4daf3b49d336614cb35541edc12f24ec9e68535c | |
| parent | 4399d1055627fe5ffaba47cf6ad6d07af3905e16 (diff) | |
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
| -rw-r--r-- | doc/src/sgml/ref/clusterdb.sgml | 5 | ||||
| -rw-r--r-- | doc/src/sgml/ref/reindexdb.sgml | 5 | ||||
| -rw-r--r-- | 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 dd1c9e52743..309951e46ff 100644 --- a/doc/src/sgml/ref/reindexdb.sgml +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -351,9 +351,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 61c2e7d2373..62c05ecab20 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -444,9 +444,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 |