From 0ad830a8b5fd4be92df9af5c0189c95f9d4ab629 Mon Sep 17 00:00:00 2001 From: Peter Smith Date: Fri, 13 Dec 2024 14:14:34 +1100 Subject: [PATCH v1] DOCS: Make the Server Application docs synopses more consistent. --- doc/src/sgml/ref/initdb.sgml | 8 ++++---- doc/src/sgml/ref/pg_createsubscriber.sgml | 4 ++-- doc/src/sgml/ref/pg_rewind.sgml | 10 +++++----- doc/src/sgml/ref/pg_waldump.sgml | 4 ++-- doc/src/sgml/ref/pg_walsummary.sgml | 14 ++++++++++++-- doc/src/sgml/ref/pgupgrade.sgml | 16 ++++++++-------- 6 files changed, 33 insertions(+), 23 deletions(-) diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 0c32114..adcbe0b 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -25,10 +25,10 @@ PostgreSQL documentation option - + - directory + datadir @@ -190,8 +190,8 @@ PostgreSQL documentation - - + + This option specifies the directory where the database cluster diff --git a/doc/src/sgml/ref/pg_createsubscriber.sgml b/doc/src/sgml/ref/pg_createsubscriber.sgml index df1a92b..61a5d0b 100644 --- a/doc/src/sgml/ref/pg_createsubscriber.sgml +++ b/doc/src/sgml/ref/pg_createsubscriber.sgml @@ -96,8 +96,8 @@ PostgreSQL documentation - - + + 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 dc039d8..817f85b 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -28,9 +28,9 @@ PostgreSQL documentation - directory + datadir - + @@ -142,8 +142,8 @@ PostgreSQL documentation - - + + This option specifies the target data directory that is synchronized @@ -154,7 +154,7 @@ PostgreSQL documentation - + Specifies the file system path to the data directory of the source diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml index ce23add..d1715ff 100644 --- a/doc/src/sgml/ref/pg_waldump.sgml +++ b/doc/src/sgml/ref/pg_waldump.sgml @@ -22,8 +22,8 @@ PostgreSQL documentation pg_waldump - - + option + startsegendseg diff --git a/doc/src/sgml/ref/pg_walsummary.sgml b/doc/src/sgml/ref/pg_walsummary.sgml index 57b2d24..9bc1b7a 100644 --- a/doc/src/sgml/ref/pg_walsummary.sgml +++ b/doc/src/sgml/ref/pg_walsummary.sgml @@ -23,7 +23,7 @@ PostgreSQL documentation pg_walsummary option - file + filename @@ -31,7 +31,7 @@ PostgreSQL documentation Description pg_walsummary is used to print the contents of - WAL summary files. These binary files are found with the + WAL summary files. These binary files are found in the pg_wal/summaries subdirectory of the data directory, and can be converted to text using this tool. This is not ordinarily necessary, since WAL summary files primarily exist to support @@ -57,6 +57,16 @@ PostgreSQL documentation + filename + + + A binary WAL summary file, found in the pg_wal/summaries + subdirectory of the data directory. + + + + + diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index 4777381..be48ded 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -81,15 +81,15 @@ PostgreSQL documentation - bindir - bindir + oldbindir + oldbindir the old PostgreSQL executable directory; environment variable PGBINOLD - bindir - bindir + newbindir + newbindir the new PostgreSQL executable directory; default is the directory where pg_upgrade resides; environment variable PGBINNEW @@ -102,15 +102,15 @@ PostgreSQL documentation - configdir - configdir + oldconfigdir + oldconfigdir the old database cluster configuration directory; environment variable PGDATAOLD - configdir - configdir + newconfigdir + newconfigdir the new database cluster configuration directory; environment variable PGDATANEW -- 1.8.3.1