doc: Missing markup, punctuation and wordsmithing
authorDaniel Gustafsson <dgustafsson@postgresql.org>
Wed, 2 Oct 2024 12:50:56 +0000 (14:50 +0200)
committerDaniel Gustafsson <dgustafsson@postgresql.org>
Wed, 2 Oct 2024 12:50:56 +0000 (14:50 +0200)
Various improvements to the documentation like adding missing
markup, improving punctuation, ensuring consistent spelling of
words and minor wordsmithing.

Author: Oleg Sibiryakov <o.sibiryakov@postgrespro.ru>
Discussion: https://postgr.es/m/b7d0a03c-107e-48c7-a5c9-2c6f73cdf78f@postgrespro.ru

16 files changed:
doc/src/sgml/catalogs.sgml
doc/src/sgml/charset.sgml
doc/src/sgml/config.sgml
doc/src/sgml/func.sgml
doc/src/sgml/libpq.sgml
doc/src/sgml/protocol.sgml
doc/src/sgml/ref/alter_table.sgml
doc/src/sgml/ref/copy.sgml
doc/src/sgml/ref/create_subscription.sgml
doc/src/sgml/ref/pgupgrade.sgml
doc/src/sgml/sepgsql.sgml
doc/src/sgml/syntax.sgml
doc/src/sgml/system-views.sgml
doc/src/sgml/trigger.sgml
doc/src/sgml/user-manag.sgml
doc/src/sgml/wal.sgml

index bfb97865e18bde033e6d3be12b2dbe8a6f258933..964c819a02d000a935de3e5f39f85d23df1d5cd1 100644 (file)
@@ -8041,7 +8041,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
       </para>
       <para>
        If true, the associated replication slots (i.e. the main slot and the
-       table sync slots) in the upstream database are enabled to be
+       table synchronization slots) in the upstream database are enabled to be
        synchronized to the standbys
       </para></entry>
      </row>
index 834cb30c85a19290ce5fc1222ca879c2c5f54eb4..1ef5322b912ee6f5e775cbd3859f34a99685d3e9 100644 (file)
@@ -862,7 +862,7 @@ SELECT * FROM test1 ORDER BY a || b COLLATE "fr_FR";
         This SQL standard collation sorts using the Unicode Collation
         Algorithm with the Default Unicode Collation Element Table.  It is
         available in all encodings.  ICU support is required to use this
-        collation, and behavior may change if Postgres is built with a
+        collation, and behavior may change if <productname>PostgreSQL</productname> is built with a
         different version of ICU.  (This collation has the same behavior as
         the ICU root locale; see <xref
         linkend="collation-managing-predefined-icu-und-x-icu"/>.)
@@ -897,7 +897,7 @@ SELECT * FROM test1 ORDER BY a || b COLLATE "fr_FR";
         expressions), it uses the POSIX Compatible variant of Unicode <ulink
         url="https://www.unicode.org/reports/tr18/#Compatibility_Properties">Compatibility
         Properties</ulink>.  Behavior is efficient and stable within a
-        <productname>Postgres</productname> major version.  This collation is
+        <productname>PostgreSQL</productname> major version.  This collation is
         only available for encoding <literal>UTF8</literal>.
        </para>
       </listitem>
index 08173ecb5c441b4b458fe5f5735afacc0ae2c328..9707d5238daa85d41344636bc4c39f30f07e46eb 100644 (file)
@@ -708,7 +708,7 @@ include_dir 'conf.d'
        </para>
 
        <para>
-        PostgreSQL sizes certain resources based directly on the value of
+        <productname>PostgreSQL</productname> sizes certain resources based directly on the value of
         <varname>max_connections</varname>. Increasing its value leads to
         higher allocation of those resources, including shared memory.
        </para>
@@ -6422,7 +6422,7 @@ SELECT * FROM parent WHERE key = 2400;
        </para>
        <para>
         If <systemitem>csvlog</systemitem> is included in <varname>log_destination</varname>,
-        log entries are output in <quote>comma separated
+        log entries are output in <quote>comma-separated
         value</quote> (<acronym>CSV</acronym>) format, which is convenient for
         loading logs into programs.
         See <xref linkend="runtime-config-logging-csvlog"/> for details.
@@ -10838,7 +10838,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
         Turning this setting off is intended for environments where the
         configuration of <productname>PostgreSQL</productname> is managed by
         some external tool.
-        In such environments, a well intentioned superuser might
+        In such environments, a well-intentioned superuser might
         <emphasis>mistakenly</emphasis> use <command>ALTER SYSTEM</command>
         to change the configuration instead of using the external tool.
         This might result in unintended behavior, such as the external tool
index d6acdd3059ea8a0226a9dba0c338ea836a4beeeb..7b4fbb50471b9e1c1d41be7edbc429970463ceed 100644 (file)
@@ -21437,7 +21437,7 @@ SELECT NULLIF(value, '(none)') ...
        </para>
        <para>
         Extracts the lower bound of the multirange (<literal>NULL</literal> if the
-        multirange is empty has no lower bound).
+        multirange is empty or has no lower bound).
        </para>
        <para>
         <literal>lower('{[1.1,2.2)}'::nummultirange)</literal>
index e56c12acfa2c337641960eeb4dff7445081ecf3e..afc9346757a7241db84b294a576994b32ea56633 100644 (file)
@@ -545,9 +545,9 @@ int PQsocketPoll(int sock, int forRead, int forWrite,
        the Unix epoch (that is, <type>time_t</type> times 1 million).
        Timeout is infinite if <parameter>end_time</parameter>
        is <literal>-1</literal>.  Timeout is immediate (no blocking) if
-       end_time is <literal>0</literal> (or indeed, any time before now).
-       Timeout values can be calculated conveniently by adding the desired
-       number of microseconds to the result of
+       <parameter>end_time</parameter> is <literal>0</literal> (or indeed, any
+       time before now).  Timeout values can be calculated conveniently by
+       adding the desired number of microseconds to the result of
        <xref linkend="libpq-PQgetCurrentTimeUSec"/>.
        Note that the underlying system calls may have less than microsecond
        precision, so that the actual delay may be imprecise.
@@ -1830,11 +1830,12 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
           <term><literal>direct</literal></term>
           <listitem>
            <para>
-             start SSL handshake directly after establishing the TCP/IP
-             connection.  This is only allowed with sslmode=require or higher,
-             because the weaker settings could lead to unintended fallback to
-             plaintext authentication when the server does not support direct
-             SSL handshake.
+            start SSL handshake directly after establishing the TCP/IP
+            connection.  This is only allowed with
+            <literal>sslmode=require</literal> or higher, because the weaker
+            settings could lead to unintended fallback to plaintext
+            authentication when the server does not support direct SSL
+            handshake.
            </para>
           </listitem>
          </varlistentry>
@@ -9582,7 +9583,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
    <para>
     For backwards compatibility with earlier versions of PostgreSQL, if a
     root CA file exists, the behavior of
-    <literal>sslmode</literal>=<literal>require</literal> will be the same
+    <literal>sslmode=require</literal> will be the same
     as that of <literal>verify-ca</literal>, meaning the server certificate
     is validated against the CA. Relying on this behavior is discouraged,
     and applications that need certificate validation should always use
index 2d2481bb8b8a636c56f5952a2099f1419de846d0..057c46f3f578273bfed9f6c429d8b676d826f67d 100644 (file)
@@ -3265,7 +3265,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
      </term>
      <listitem>
       <para>
-       Comma separated list of publication names for which to subscribe
+       Comma-separated list of publication names for which to subscribe
        (receive changes). The individual publication names are treated
        as standard objects names and can be quoted the same as needed.
        At least one publication name is required.
@@ -3330,8 +3330,9 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
      </term>
      <listitem>
       <para>
-       Option to send changes by their origin.  Possible values are "none"
-       to only send the changes that have no origin associated, or "any"
+       Option to send changes by their origin.  Possible values are
+       <literal>none</literal> to only send the changes that have no origin
+       associated, or <literal>any</literal>
        to send the changes regardless of their origin.  This can be used
        to avoid loops (infinite replication of the same data) among
        replication nodes.
index 925f1084e006170036082da5a1a05994cc0955b2..c5a14674804f3d4e24b6da98f42cc52c2bcb1147 100644 (file)
@@ -1123,8 +1123,8 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
   </para>
 
   <para>
-   All the forms of ALTER TABLE that act on a single table, except
-   <literal>RENAME</literal>, <literal>SET SCHEMA</literal>,
+   All the forms of <command>ALTER TABLE</command> that act on a single table,
+   except <literal>RENAME</literal>, <literal>SET SCHEMA</literal>,
    <literal>ATTACH PARTITION</literal>, and
    <literal>DETACH PARTITION</literal> can be combined into
    a list of multiple alterations to be applied together.  For example, it
index fdbd20bc50b100198b4103ae9b7ea7c9e35818e6..33633447f16f32ee813a23d739d2dde3ffb0d927 100644 (file)
@@ -427,7 +427,7 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
     <term><literal>LOG_VERBOSITY</literal></term>
     <listitem>
      <para>
-      Specify the amount of messages emitted by a <command>COPY</command>
+      Specifies the amount of messages emitted by a <command>COPY</command>
       command: <literal>default</literal> or <literal>verbose</literal>. If
       <literal>verbose</literal> is specified, additional messages are emitted
       during processing.
@@ -779,7 +779,7 @@ COPY <replaceable class="parameter">count</replaceable>
    <title>CSV Format</title>
 
    <para>
-    This format option is used for importing and exporting the Comma
+    This format option is used for importing and exporting the Comma-
     Separated Value (<literal>CSV</literal>) file format used by many other
     programs, such as spreadsheets. Instead of the escaping rules used by
     <productname>PostgreSQL</productname>'s standard text format, it
index 740b7d94210418d89f27dd64fbae276bf07d50f8..8a3096e62b5c6519dcb371a520f45f31e116b791 100644 (file)
@@ -185,7 +185,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
 
          <para>
           When setting <literal>slot_name</literal> to a valid name and
-          <literal>create_slot</literal> to false, the
+          <literal>create_slot</literal> to <literal>false</literal>, the
           <literal>failover</literal> property value of the named slot may
           differ from the counterpart <literal>failover</literal> parameter
           specified in the subscription. Always ensure the slot property
@@ -474,7 +474,8 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
   <para>
    If any table in the publication has a <literal>WHERE</literal> clause, rows
    for which the <replaceable class="parameter">expression</replaceable>
-   evaluates to false or null will not be published. If the subscription has
+   evaluates to <literal>false</literal> or <literal>NULL</literal> will not be
+   published. If the subscription has
    several publications in which the same table has been published with
    different <literal>WHERE</literal> clauses, a row will be published if any
    of the expressions (referring to that publish operation) are satisfied. In
index 41d5566a44272791af7137bf22d1a4290233e6d7..4777381dac25707be4339d7e07004df95d28b8bc 100644 (file)
@@ -67,7 +67,7 @@ PostgreSQL documentation
  </para>
 
   <para>
-   pg_upgrade supports upgrades from 9.2.X and later to the current
+   <application>pg_upgrade</application> supports upgrades from 9.2.X and later to the current
    major release of <productname>PostgreSQL</productname>, including snapshot and beta releases.
   </para>
  </refsect1>
index bc308e3142d6f8a37930c4a212c82384caf10595..ca038d710428ddf794bcb63740ff514d721f715c 100644 (file)
@@ -87,7 +87,7 @@ Policy from config file:        targeted
   </para>
 
   <para>
-   To build this module specify <xref
+   To build this module, specify <xref
    linkend="configure-option-with-sepgsql"/> (when using <link
    linkend="install-make">make and autoconf</link> ) or <xref
    linkend="configure-with-sepgsql-meson"/> (when using <link
index 4dfbbd0862614ca7d653f88af81024177309d169..916189a7d68ce9079be51e3f41b6f394fd3aac80 100644 (file)
@@ -2496,7 +2496,7 @@ SELECT getf1(CAST(ROW(11,'this is a test',2.5) AS myrowtype));
    linkend="functions-comparison"/>, to compare one row against another
    as described in <xref linkend="functions-comparisons"/>, and to
    use them in connection with subqueries, as discussed in <xref
-   linkend="functions-subquery"/>,
+   linkend="functions-subquery"/>.
   </para>
 
   </sect2>
index 634a4c0fab46db7667042392ffb996ebe39ba38a..61d28e701f29a8af83f8cfe969b43cb03af87eca 100644 (file)
@@ -2586,7 +2586,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        True if this logical slot conflicted with recovery (and so is now
        invalidated). When this column is true, check
        <structfield>invalidation_reason</structfield> column for the conflict
-       reason. Always NULL for physical slots.
+       reason. Always <literal>NULL</literal> for physical slots.
       </para></entry>
      </row>
 
@@ -3945,7 +3945,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        range type column. (Null for non-range types.)
       </para>
       <para>
-       This histogram is calculated using the <literal>subtype_diff</literal>
+       This histogram is calculated using the <function>subtype_diff</function>
        range function regardless of whether range bounds are inclusive.
       </para></entry>
      </row>
index 49382d07fa85305b4f810bf48a77d544486f1272..a9abaab905690a7434f9351873f40b4a09c32d4c 100644 (file)
    <para>
     If a foreign key constraint specifies referential actions (that
     is, cascading updates or deletes), those actions are performed via
-    ordinary SQL update or delete commands on the referencing table.
+    ordinary SQL <command>UPDATE</command> or <command>DELETE</command>
+    commands on the referencing table.
     In particular, any triggers that exist on the referencing table
     will be fired for those changes.  If such a trigger modifies or
     blocks the effect of one of these commands, the end result could
index 0a005481d1bf2e63282269fbfae58099db42e1a5..ed18704a9c2ab0f172d372923a033451a93bbe52 100644 (file)
@@ -407,7 +407,7 @@ REVOKE <replaceable>group_role</replaceable> FROM <replaceable>role1</replaceabl
    temporarily <quote>become</quote> the group role.  In this state, the
    database session has access to the privileges of the group role rather
    than the original login role, and any database objects created are
-   considered owned by the group role not the login role.  Second, member
+   considered owned by the group role, not the login role.  Second, member
    roles that have been granted membership with the
    <literal>INHERIT</literal> option automatically have use of the
    privileges of those directly or indirectly a member of, though the
index 0ba0c930b7823fd6f76459ed36e362d5c5e9e86a..a34cddb5ed48e165e04da89ab7746e39bba3f468 100644 (file)
 
   <para>
    In some cases, when the WAL size on the primary increases quickly,
-   for instance during massive INSERT,
+   for instance during massive <command>INSERT</command>,
    the <structfield>restartpoints_req</structfield> counter on the standby
    may demonstrate a peak growth.
    This occurs because requests to create a new restartpoint due to increased
-   XLOG consumption cannot be performed because the safe checkpoint record
+   WAL consumption cannot be performed because the safe checkpoint record
    since the last restartpoint has not yet been replayed on the standby.
    This behavior is normal and does not lead to an increase in system resource
    consumption.