public inbox for [email protected]help / color / mirror / Atom feed
DOCS - System Applications 'datadir' parameter 4+ messages / 2 participants [nested] [flat]
* DOCS - System Applications 'datadir' parameter @ 2026-02-18 07:27 Peter Smith <[email protected]> 2026-03-20 03:43 ` Re: DOCS - System Applications 'datadir' parameter Peter Smith <[email protected]> 2026-03-23 16:14 ` Re: DOCS - System Applications 'datadir' parameter Bruce Momjian <[email protected]> 0 siblings, 2 replies; 4+ messages in thread From: Peter Smith @ 2026-02-18 07:27 UTC (permalink / raw) To: PostgreSQL Hackers <[email protected]> Hi. In most places, each of the Server Application documentation pages [1] refers to the directory where the database cluster lives as 'datadir'. However, a few places called it 'directory' instead. This patch changes the outliers also to 'datadir', making everything more consistent. e.g. initdb: change in Synopsis and Options pg_checksums: change in Options pg_controldata: OK pg_createsubscriber: change in Options pg_ctl: OK pg_resetwal: OK pg_rewind: change in Synopsis and Options pg_upgrade: Leave as-is (e.g. configdir may not be the same as datadir) postgres: OK PSA patch for details. ====== [1] https://www.postgresql.org/docs/devel/reference-server.html Kind Regards, Peter Smith. Fujitsu Australia Attachments: [application/octet-stream] v1-0001-DOCS-use-datadir-parameter-consistently.patch (4.8K, 2-v1-0001-DOCS-use-datadir-parameter-consistently.patch) download | inline diff: From f133448cc95b6ee44db1dfbf5e11a97abf423fdd Mon Sep 17 00:00:00 2001 From: Peter Smith <[email protected]> Date: Wed, 18 Feb 2026 18:20:28 +1100 Subject: [PATCH v1] DOCS - use 'datadir' parameter consistently --- doc/src/sgml/ref/initdb.sgml | 6 +++--- doc/src/sgml/ref/pg_checksums.sgml | 4 ++-- doc/src/sgml/ref/pg_createsubscriber.sgml | 4 ++-- doc/src/sgml/ref/pg_rewind.sgml | 10 +++++----- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 7613174c18b..bd0dbff8caa 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -28,7 +28,7 @@ PostgreSQL documentation <arg choice="plain"><option>--pgdata</option></arg> <arg choice="plain"><option>-D</option></arg> </group> - <replaceable> directory</replaceable> + <replaceable> datadir</replaceable> </group> </cmdsynopsis> </refsynopsisdiv> @@ -190,8 +190,8 @@ PostgreSQL documentation </varlistentry> <varlistentry id="app-initdb-option-pgdata"> - <term><option>-D <replaceable class="parameter">directory</replaceable></option></term> - <term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term> + <term><option>-D <replaceable class="parameter">datadir</replaceable></option></term> + <term><option>--pgdata=<replaceable class="parameter">datadir</replaceable></option></term> <listitem> <para> This option specifies the directory where the database cluster diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml index e9e393495df..b64393c813f 100644 --- a/doc/src/sgml/ref/pg_checksums.sgml +++ b/doc/src/sgml/ref/pg_checksums.sgml @@ -61,8 +61,8 @@ PostgreSQL documentation <variablelist> <varlistentry> - <term><option>-D <replaceable>directory</replaceable></option></term> - <term><option>--pgdata=<replaceable>directory</replaceable></option></term> + <term><option>-D <replaceable>datadir</replaceable></option></term> + <term><option>--pgdata=<replaceable>datadir</replaceable></option></term> <listitem> <para> Specifies the directory where the database cluster is stored. diff --git a/doc/src/sgml/ref/pg_createsubscriber.sgml b/doc/src/sgml/ref/pg_createsubscriber.sgml index cf45ff3573d..6e17cee18eb 100644 --- a/doc/src/sgml/ref/pg_createsubscriber.sgml +++ b/doc/src/sgml/ref/pg_createsubscriber.sgml @@ -126,8 +126,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>-D <replaceable class="parameter">directory</replaceable></option></term> - <term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term> + <term><option>-D <replaceable class="parameter">datadir</replaceable></option></term> + <term><option>--pgdata=<replaceable class="parameter">datadir</replaceable></option></term> <listitem> <para> The target directory that contains a cluster directory from a physical diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml index 24cf57d68ff..f704dc108e6 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -28,9 +28,9 @@ PostgreSQL documentation <arg choice="plain"><option>-D</option></arg> <arg choice="plain"><option>--target-pgdata</option></arg> </group> - <replaceable> directory</replaceable> + <replaceable> datadir</replaceable> <group choice="req"> - <arg choice="plain"><option>--source-pgdata=<replaceable>directory</replaceable></option></arg> + <arg choice="plain"><option>--source-pgdata=<replaceable>datadir</replaceable></option></arg> <arg choice="plain"><option>--source-server=<replaceable>connstr</replaceable></option></arg> </group> </group> @@ -162,8 +162,8 @@ PostgreSQL documentation <variablelist> <varlistentry> - <term><option>-D <replaceable class="parameter">directory</replaceable></option></term> - <term><option>--target-pgdata=<replaceable class="parameter">directory</replaceable></option></term> + <term><option>-D <replaceable class="parameter">datadir</replaceable></option></term> + <term><option>--target-pgdata=<replaceable class="parameter">datadir</replaceable></option></term> <listitem> <para> This option specifies the target data directory that is synchronized @@ -174,7 +174,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>--source-pgdata=<replaceable class="parameter">directory</replaceable></option></term> + <term><option>--source-pgdata=<replaceable class="parameter">datadir</replaceable></option></term> <listitem> <para> Specifies the file system path to the data directory of the source -- 2.47.3 ^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: DOCS - System Applications 'datadir' parameter 2026-02-18 07:27 DOCS - System Applications 'datadir' parameter Peter Smith <[email protected]> @ 2026-03-20 03:43 ` Peter Smith <[email protected]> 1 sibling, 0 replies; 4+ messages in thread From: Peter Smith @ 2026-03-20 03:43 UTC (permalink / raw) To: PostgreSQL Hackers <[email protected]> Ping. This thread has been idle for 1 month. Is there anything else I can do to move it forwards? ====== Kind Regards, Peter Smith. Fujitsu Australia. ^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: DOCS - System Applications 'datadir' parameter 2026-02-18 07:27 DOCS - System Applications 'datadir' parameter Peter Smith <[email protected]> @ 2026-03-23 16:14 ` Bruce Momjian <[email protected]> 2026-03-23 22:38 ` Re: DOCS - System Applications 'datadir' parameter Peter Smith <[email protected]> 1 sibling, 1 reply; 4+ messages in thread From: Bruce Momjian @ 2026-03-23 16:14 UTC (permalink / raw) To: Peter Smith <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On Wed, Feb 18, 2026 at 06:27:50PM +1100, Peter Smith wrote: > Hi. > > In most places, each of the Server Application documentation pages [1] > refers to the directory where the database cluster lives as 'datadir'. > However, a few places called it 'directory' instead. > > This patch changes the outliers also to 'datadir', making everything > more consistent. Good catch. These clearly need to be datadirs and not just any directory. Patch applied to master, thanks. -- Bruce Momjian <[email protected]> https://momjian.us EDB https://enterprisedb.com Do not let urgent matters crowd out time for investment in the future. ^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: DOCS - System Applications 'datadir' parameter 2026-02-18 07:27 DOCS - System Applications 'datadir' parameter Peter Smith <[email protected]> 2026-03-23 16:14 ` Re: DOCS - System Applications 'datadir' parameter Bruce Momjian <[email protected]> @ 2026-03-23 22:38 ` Peter Smith <[email protected]> 0 siblings, 0 replies; 4+ messages in thread From: Peter Smith @ 2026-03-23 22:38 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On Tue, Mar 24, 2026 at 3:14 AM Bruce Momjian <[email protected]> wrote: > ... > Good catch. These clearly need to be datadirs and not just any > directory. Patch applied to master, thanks. > Thanks for pushing! ====== Kind Regards, Peter Smith. Fujitsu Australia ^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2026-03-23 22:38 UTC | newest] Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2026-02-18 07:27 DOCS - System Applications 'datadir' parameter Peter Smith <[email protected]> 2026-03-20 03:43 ` Peter Smith <[email protected]> 2026-03-23 16:14 ` Bruce Momjian <[email protected]> 2026-03-23 22:38 ` Peter Smith <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox