doc: Assorted documentation improvements

A set of wording improvements and spelling fixes.

Author: Oleg Sibiryakov <o.sibiryakov@postgrespro.ru>
Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
Reviewed-by: Peter Eisentraut <peter@eisentraut.org>
Discussion: https://postgr.es/m/e62bedb5-c26f-4d37-b4ed-ce9b55f1e980@postgrespro.ru

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index df1c3eaaa5854708574d567853b9ceb67eb14ac8..023b3f03ba9356628ff9b30789b183d8b5a5f47b 100644 (file)
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1234,7 +1234,7 @@ include_dir 'conf.d'
       </term>
       <listitem>
        <para>
-        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
         <link linkend="auth-oauth"><literal>oauth</literal> HBA entries</link>
@@ -1400,7 +1400,7 @@ include_dir 'conf.d'
        <para>
         Specifies a list of cipher suites that are allowed by connections using
         <acronym>TLS</acronym> 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 <productname>OpenSSL</productname> will be used.
        </para>
 
@@ -2436,8 +2436,8 @@ include_dir 'conf.d'
       </term>
       <listitem>
        <para>
-        Sets the maximum number of open files each server subprocess is
-        allowed to open simultaneously;  files already opened in the
+        Sets the maximum number of files each server subprocess is
+        allowed to have open simultaneously;  files already opened in the
         postmaster are not counted toward this limit. The default is one
         thousand files.
        </para>

diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
index 593202f4fb2592375e4734a884d5a9fcf2135c59..fe8d73e1f8c010355bae8055ef28e65959281d3b 100644 (file)
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
@@ -3170,7 +3170,7 @@ ninja install
        <para>
         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
         <xref linkend="regress-additional"/> for details. If the
         <envar>PG_TEST_EXTRA</envar> environment variable is set when the

diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index 781a01067f7d6d0c8ca15b7aba68f040646d655a..9b032fbf675093b0a70ca7faa47e69d43231bf1f 100644 (file)
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -1226,7 +1226,7 @@ postgres=# SELECT postgres_fdw_disconnect_all();
     <term><literal>PostgresFdwCleanupResult</literal></term>
     <listitem>
      <para>
-      Waiting for transaction abort on remote server.
+      Waiting for transaction abort on a remote server.
      </para>
     </listitem>
    </varlistentry>

diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml
index af476c82fcc1e2f83ff3d12498506b99a21183e9..2101442c90fcb6e2060807d09710737ac5007ef3 100644 (file)
--- 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.
    </para>
 
    <para>
-    After you have successfully completed this tutorial you will want to
+    After you have successfully completed this tutorial, you will want to
     read the <xref linkend="sql"/> section to gain a better understanding
     of the SQL language, or <xref linkend="client-interfaces"/> for
     information about developing applications with

diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 9d7552328736153879570f0b124a5139799cc306..41c5954a424ac679ea4ec677beac49f8133e0c3f 100644 (file)
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -1636,7 +1636,7 @@ SELCT 1/0;<!-- this typo is intentional -->
    <para>
      Likewise the server expects the client to not begin
      the <acronym>SSL</acronym> negotiation until it receives the server's
-     single byte response to the <acronym>SSL</acronym> request.  If the
+     single-byte response to the <acronym>SSL</acronym> request.  If the
      client begins the <acronym>SSL</acronym> 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

diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml
index 2cc24f9158334852f7e8b8ab59b831cf2d5cb7a5..5380d776bafb168c1efbb21d0da8d7783ab88057 100644 (file)
--- a/doc/src/sgml/ref/pg_recvlogical.sgml
+++ b/doc/src/sgml/ref/pg_recvlogical.sgml
@@ -84,7 +84,7 @@ PostgreSQL documentation
        </para>
 
        <para>
-        The <option>--slot</option> and <option>--dbname</option> are required
+        The <option>--slot</option> and <option>--dbname</option> options are required
         for this action.
        </para>
 
@@ -104,7 +104,7 @@ PostgreSQL documentation
        </para>
 
        <para>
-        The <option>--slot</option> is required for this action.
+        The <option>--slot</option> option is required for this action.
        </para>
       </listitem>
      </varlistentry>
@@ -121,8 +121,8 @@ PostgreSQL documentation
        </para>
 
        <para>
-        The <option>--slot</option> and <option>--dbname</option>,
-        <option>--file</option> are required for this action.
+        The <option>--slot</option>, <option>--dbname</option>, and
+        <option>--file</option> options are required for this action.
        </para>
 
        <para>

diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml
index ecfc3d2f2b764271593bf85e6efeec990f592299..2e401d1ceb8bc9be0208613d1020eff846b732c5 100644 (file)
--- 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, <option>--exit-on-abort</option> is specified, all of the
+         However, if <option>--exit-on-abort</option> is specified, all of the
          threads stop immediately in this case.
        </para>
      </listitem>

diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index c05cd2f96f596f746078821c9c10e83a1d1cc929..fd1e142d5591ac5ecdd0ae7336af7edf01a96aa6 100644 (file)
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -266,7 +266,7 @@ make check-world -j8 >/dev/null
   <para>
    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 <command>make</command> or environment
    variable <varname>PG_TEST_EXTRA</varname> to a whitespace-separated list,
    for example:
@@ -337,7 +337,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
        <filename>src/bin/pg_upgrade/t/002_pg_upgrade.pl</filename> which
        cycles the regression database through <command>pg_dump</command>/
        <command>pg_restore</command>.  Not enabled by default because it
-       is resource intensive.
+       is resource-intensive.
       </para>
      </listitem>
     </varlistentry>
@@ -368,7 +368,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
       <para>
        Uses <literal>wal_consistency_checking=all</literal> while running
        certain tests under <filename>src/test/recovery</filename>.  Not
-       enabled by default because it is resource intensive.
+       enabled by default because it is resource-intensive.
       </para>
      </listitem>
     </varlistentry>
@@ -378,7 +378,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
      <listitem>
       <para>
        Runs the test suite under <filename>src/test/modules/xid_wraparound</filename>.
-       Not enabled by default because it is resource intensive.
+       Not enabled by default because it is resource-intensive.
       </para>
      </listitem>
     </varlistentry>

diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml
index 7971498fe75a2a2e00142ded0b42e49daa69d848..0e623e7fb86766ba561691374020354cb55fbd52 100644 (file)
--- a/doc/src/sgml/system-views.sgml
+++ b/doc/src/sgml/system-views.sgml
@@ -53,7 +53,7 @@
     <tbody>
      <row>
       <entry><link linkend="view-pg-aios"><structname>pg_aios</structname></link></entry>
-      <entry>In-use asynchronous IO handles</entry>
+      <entry>in-use asynchronous IO handles</entry>
      </row>
 
      <row>

diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml
index 7dcd7d32329ca9c0dcb68f1dbf5b1098aadc18c0..55a99c0ff34fd3ace6095bb0059fe98a88492265 100644 (file)
--- 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
      <function>DirectFunctionCall<replaceable>n</replaceable>(func,
      arg1, ..., argn)</function>.  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.
     </para>
 
@@ -3940,7 +3940,7 @@ extern bool InjectionPointDetach(const char *name);
     </para>
 
     <para>
-     Enabling injections points requires
+     Enabling injection points requires
      <option>--enable-injection-points</option> with
      <command>configure</command> or <option>-Dinjection_points=true</option>
      with <application>Meson</application>.