From a641eb6ed524d1af9e3b6fb9cc8e954a3e4831e0 Mon Sep 17 00:00:00 2001 From: Daniel Gustafsson Date: Fri, 14 Nov 2025 09:46:24 +0100 Subject: [PATCH v3] doc: Assorted documentation improvements A set of wording improvements and spelling fixes. Author: Oleg Sibiryakov Reviewed-by: Daniel Gustafsson Reviewed-by: Peter Eisentraut Discussion: https://postgr.es/m/e62bedb5-c26f-4d37-b4ed-ce9b55f1e980@postgrespro.r --- doc/src/sgml/config.sgml | 6 +++--- doc/src/sgml/installation.sgml | 2 +- doc/src/sgml/postgres-fdw.sgml | 2 +- doc/src/sgml/postgres.sgml | 2 +- doc/src/sgml/protocol.sgml | 10 +++++----- doc/src/sgml/ref/pg_recvlogical.sgml | 8 ++++---- doc/src/sgml/ref/pgbench.sgml | 2 +- doc/src/sgml/regress.sgml | 8 ++++---- doc/src/sgml/system-views.sgml | 2 +- doc/src/sgml/xfunc.sgml | 4 ++-- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index d7e48f61905..21f49f4764d 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -1234,7 +1234,7 @@ include_dir 'conf.d' - The library/libraries to use for validating OAuth connection tokens. If + Sets the library/libraries to use for validating OAuth connection tokens. If only one validator library is provided, it will be used by default for any OAuth connections; otherwise, all oauth HBA entries @@ -1400,7 +1400,7 @@ include_dir 'conf.d' Specifies a list of cipher suites that are allowed by connections using TLS version 1.3. Multiple cipher suites can be - specified by using a colon separated list. If left blank, the default + specified by using a colon-separated list. If left blank, the default set of cipher suites in OpenSSL will be used. @@ -2436,7 +2436,7 @@ include_dir 'conf.d' - Sets the maximum number of open files each server subprocess is + Sets the maximum number of files each server subprocess is allowed to open simultaneously; files already opened in the postmaster are not counted toward this limit. The default is one thousand files. diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 593202f4fb2..fe8d73e1f8c 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -3170,7 +3170,7 @@ ninja install Enable additional test suites, which are not run by default because they are not secure to run on a multiuser system, require special - software to run, or are resource intensive. The argument is a + software to run, or are resource-intensive. The argument is a whitespace-separated list of tests to enable. See for details. If the PG_TEST_EXTRA environment variable is set when the diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml index 781a01067f7..9b032fbf675 100644 --- a/doc/src/sgml/postgres-fdw.sgml +++ b/doc/src/sgml/postgres-fdw.sgml @@ -1226,7 +1226,7 @@ postgres=# SELECT postgres_fdw_disconnect_all(); PostgresFdwCleanupResult - Waiting for transaction abort on remote server. + Waiting for transaction abort on a remote server. diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index af476c82fcc..2101442c90f 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -49,7 +49,7 @@ break is not needed in a wider output rendering. - After you have successfully completed this tutorial you will want to + After you have successfully completed this tutorial, you will want to read the section to gain a better understanding of the SQL language, or for information about developing applications with diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index d1b9af11b07..aa3c5130d94 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1636,7 +1636,7 @@ SELCT 1/0; Likewise the server expects the client to not begin the SSL negotiation until it receives the server's - single byte response to the SSL request. If the + single-byte response to the SSL request. If the client begins the SSL negotiation immediately without waiting for the server response to be received it can reduce connection latency by one round-trip. However this comes at the cost of not being @@ -2228,7 +2228,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" - Create a physical or logical replication + Creates a physical or logical replication slot. See for more about replication slots. @@ -2502,7 +2502,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" - Instructs server to start streaming WAL, starting at + Instructs the server to start streaming WAL, starting at WAL location XXX/XXX. If TIMELINE option is specified, streaming starts on timeline tli; @@ -2898,7 +2898,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" START_REPLICATION SLOT slot_name LOGICAL XXX/XXX [ ( option_name [ option_value ] [, ...] ) ] - Instructs server to start streaming WAL for logical replication, + Instructs the server to start streaming WAL for logical replication, starting at either WAL location XXX/XXX or the slot's confirmed_flush_lsn (see - Drops a replication slot, freeing any reserved server-side resources. + Instructs the server to drop a replication slot, freeing any reserved server-side resources. diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml index 263ebdeeab4..2a0de0cfb63 100644 --- a/doc/src/sgml/ref/pg_recvlogical.sgml +++ b/doc/src/sgml/ref/pg_recvlogical.sgml @@ -84,7 +84,7 @@ PostgreSQL documentation - The and are required + The and options are required for this action. @@ -104,7 +104,7 @@ PostgreSQL documentation - The is required for this action. + The option is required for this action. @@ -121,8 +121,8 @@ PostgreSQL documentation - The and , - are required for this action. + The , , and + options are required for this action. diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index ecfc3d2f2b7..2e401d1ceb8 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -2858,7 +2858,7 @@ statement latencies in milliseconds, failures and retries: start a connection to the database server / the socket for connecting the client to the database server has become invalid). In such cases all clients of this thread stop while other threads continue to work. - However, is specified, all of the + However, if is specified, all of the threads stop immediately in this case. diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml index 8838fe7f022..6812e3f11e0 100644 --- a/doc/src/sgml/regress.sgml +++ b/doc/src/sgml/regress.sgml @@ -254,7 +254,7 @@ make check-world -j8 >/dev/null Some test suites are not run by default, either because they are not secure to run on a multiuser system, because they require special software or - because they are resource intensive. You can decide which test suites to + because they are resource-intensive. You can decide which test suites to run additionally by setting the make or environment variable PG_TEST_EXTRA to a whitespace-separated list, for example: @@ -325,7 +325,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption' src/bin/pg_upgrade/t/002_pg_upgrade.pl which cycles the regression database through pg_dump/ pg_restore. Not enabled by default because it - is resource intensive. + is resource-intensive. @@ -356,7 +356,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption' Uses wal_consistency_checking=all while running certain tests under src/test/recovery. Not - enabled by default because it is resource intensive. + enabled by default because it is resource-intensive. @@ -366,7 +366,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption' Runs the test suite under src/test/modules/xid_wraparound. - Not enabled by default because it is resource intensive. + Not enabled by default because it is resource-intensive. diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 7971498fe75..0e623e7fb86 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -53,7 +53,7 @@ pg_aios - In-use asynchronous IO handles + in-use asynchronous IO handles diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 7dcd7d32329..55a99c0ff34 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -2399,7 +2399,7 @@ PG_FUNCTION_INFO_V1(funcname); To call another version-1 function, you can use DirectFunctionCalln(func, arg1, ..., argn). This is particularly useful when you want - to call functions defined in the standard internal library, by using an + to call functions defined in the standard internal function library by using an interface similar to their SQL signature. @@ -3940,7 +3940,7 @@ extern bool InjectionPointDetach(const char *name); - Enabling injections points requires + Enabling injection points requires with configure or with Meson. -- 2.39.3 (Apple Git-146)