doc: wording improvements
authorBruce Momjian <bruce@momjian.us>
Fri, 27 Oct 2023 21:23:09 +0000 (17:23 -0400)
committerBruce Momjian <bruce@momjian.us>
Fri, 27 Oct 2023 21:23:34 +0000 (17:23 -0400)
Discussion: https://postgr.es/m/a5180360-ec04-ac58-25ce-3d795d3d1f6c@postgrespro.ru

Author: Ekaterina Kiryanova

Backpatch-through: master

13 files changed:
doc/src/sgml/charset.sgml
doc/src/sgml/config.sgml
doc/src/sgml/high-availability.sgml
doc/src/sgml/indices.sgml
doc/src/sgml/logicaldecoding.sgml
doc/src/sgml/monitoring.sgml
doc/src/sgml/ref/merge.sgml
doc/src/sgml/ref/pg_basebackup.sgml
doc/src/sgml/ref/pg_receivewal.sgml
doc/src/sgml/ref/pg_recvlogical.sgml
doc/src/sgml/ref/pg_restore.sgml
doc/src/sgml/ref/pg_waldump.sgml
doc/src/sgml/ref/pgbench.sgml

index 975b9dc95239ff710141ce999ebf0cb19f774f27..74783d148fef221ec0b87d2a8997b6930192e1bf 100644 (file)
@@ -293,10 +293,10 @@ initdb --locale=sv_SE
      <para>
       As explained above, the environment of the operating system provides the
       defaults for the locales of a newly initialized database cluster.  In
-      many cases, this is enough: If the operating system is configured for
-      the desired language/territory, then
-      <productname>PostgreSQL</productname> will by default also behave
-      according to that locale.
+      many cases, this is enough: if the operating system is configured for
+      the desired language/territory, by default
+      <productname>PostgreSQL</productname> will also behave according
+      to that locale.
      </para>
     </listitem>
 
index bd138236acce817e903b764e1d0453a29b1843f1..4047eefc64889944b6bc221fd55f93971a8b7244 100644 (file)
@@ -9041,7 +9041,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
        <para>
         The timeout is measured from the time a command arrives at the
         server until it is completed by the server.  If multiple SQL
-        statements appear in a single simple-Query message, the timeout
+        statements appear in a single simple-query message, the timeout
         is applied to each statement separately.
         (<productname>PostgreSQL</productname> versions before 13 usually
         treated the timeout as applying to the whole query string.)
index 5f9257313a23776a6bec860a17319487bb4ea811..eb81260bbf156728cc0158e53268f0600f96305e 100644 (file)
@@ -1359,8 +1359,8 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
 
    <para>
     If you need to re-create a standby server while transactions are
-    waiting, make sure that the commands pg_backup_start() and
-    pg_backup_stop() are run in a session with
+    waiting, make sure that the functions <function>pg_backup_start()</function>
+    and <function>pg_backup_stop()</function> are run in a session with
     <varname>synchronous_commit</varname> = <literal>off</literal>, otherwise those
     requests will wait forever for the standby to appear.
    </para>
@@ -2219,10 +2219,11 @@ HINT:  You can then restart the server after making the necessary configuration
     The cumulative statistics system is active during recovery. All scans,
     reads, blocks, index usage, etc., will be recorded normally on the
     standby. However, WAL replay will not increment relation and database
-    specific counters. I.e. replay will not increment pg_stat_all_tables
-    columns (like n_tup_ins), nor will reads or writes performed by the
-    startup process be tracked in the pg_statio views, nor will associated
-    pg_stat_database columns be incremented.
+    specific counters. I.e. replay will not increment
+    <structname>pg_stat_all_tables</structname> columns (like <structfield>n_tup_ins</structfield>),
+    nor will reads or writes performed by the startup process be tracked in the
+    <structname>pg_statio_</structname> views, nor will associated
+    <structname>pg_stat_database</structname> columns be incremented.
    </para>
 
    <para>
index 55122129d586b8ce34fdc2a23da0f47b2e863aad..992408ddc3539d1447a57dac353816425cff57d3 100644 (file)
@@ -754,7 +754,7 @@ CREATE INDEX people_names ON people ((first_name || ' ' || last_name));
   <para>
    Index expressions are relatively expensive to maintain, because the
    derived expression(s) must be computed for each row insertion
-   and <link linkend="storage-hot">non-HOT update.</link>  However, the index expressions are
+   and <link linkend="storage-hot">non-HOT update</link>. However, the index expressions are
    <emphasis>not</emphasis> recomputed during an indexed search, since they are
    already stored in the index.  In both examples above, the system
    sees the query as just <literal>WHERE indexedcolumn = 'constant'</literal>
index 8067946a25d099061d7ba383958eae850522442e..cd152d4ced987c967815d8cbd4ca65e933c290b3 100644 (file)
@@ -144,7 +144,7 @@ postgres=# SELECT pg_drop_replication_slot('regression_slot');
 </programlisting>
 
    <para>
-    The following examples shows how logical decoding is controlled over the
+    The following examples show how logical decoding is controlled over the
     streaming replication protocol, using the
     program <xref linkend="app-pgrecvlogical"/> included in the PostgreSQL
     distribution.  This requires that client authentication is set up to allow
index 9fea60b5b211b5782cb7e576a597a7a47504a0e7..faf7a5ed9d527cf4d5341328c2066ce03f14c035 100644 (file)
@@ -261,7 +261,7 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
    unnecessary and can be avoided by setting
    <varname>stats_fetch_consistency</varname> to <literal>none</literal>.
 
-   You can invoke <function>pg_stat_clear_snapshot</function>() to discard the
+   You can invoke <function>pg_stat_clear_snapshot()</function> to discard the
    current transaction's statistics snapshot or cached values (if any).  The
    next use of statistical information will (when in snapshot mode) cause a
    new snapshot to be built or (when in cache mode) accessed statistics to be
index 0995fe0c0469a7be35b569f52889c4d2a86f2b8f..0f61d472cd8251e8e56cd73a6827deb93798eb35 100644 (file)
@@ -381,9 +381,9 @@ DELETE
       An expression to assign to the column.  If used in a
       <literal>WHEN MATCHED</literal> clause, the expression can use values
       from the original row in the target table, and values from the
-      <literal>data_source</literal> row.
+      <replaceable>data_source</replaceable> row.
       If used in a <literal>WHEN NOT MATCHED</literal> clause, the
-      expression can use values from the <literal>data_source</literal>.
+      expression can use values from the <replaceable>data_source</replaceable>.
      </para>
     </listitem>
    </varlistentry>
index 712568a62df3d1dfddb18a45110a074cb9c4f80e..0b87fd2d4d6212e8c6b64c38ea7864204cbe36be 100644 (file)
@@ -422,8 +422,9 @@ PostgreSQL documentation
         A compression detail string can optionally be specified.
         If the detail string is an integer, it specifies the compression
         level.  Otherwise, it should be a comma-separated list of items,
-        each of the form <literal>keyword</literal> or
-        <literal>keyword=value</literal>.
+        each of the form
+        <replaceable>keyword</replaceable> or
+        <replaceable>keyword=value</replaceable>.
         Currently, the supported keywords are <literal>level</literal>,
         <literal>long</literal>, and <literal>workers</literal>.
         The detail string cannot be used when the compression method
@@ -1019,7 +1020,7 @@ PostgreSQL documentation
 </screen></para>
 
   <para>
-   To create a backup of a local server with one tar file for each tablespace
+   To create a backup of the local server with one tar file for each tablespace
    compressed with <application>gzip</application> at level 9, stored in the
    directory <filename>backup</filename>:
 <screen>
index 798b972d3cca699f3dd609ee10bce10af5e55a4b..8944eee2a36499e0944f36bd0e2aa57ed007cf40 100644 (file)
@@ -281,7 +281,8 @@ PostgreSQL documentation
         A compression detail string can optionally be specified.  If the
         detail string is an integer, it specifies the compression level.
         Otherwise, it should be a comma-separated list of items, each of the
-        form <literal>keyword</literal> or <literal>keyword=value</literal>.
+        form <replaceable>keyword</replaceable> or
+        <replaceable>keyword=value</replaceable>.
         Currently, the only supported keyword is <literal>level</literal>.
        </para>
        <para>
index 648d3f0f62c185774b0cafe27fa2badda620567e..95eb14b6352e29b13d307dc7547d4aa602d14de6 100644 (file)
@@ -274,7 +274,7 @@ PostgreSQL documentation
        <listitem>
        <para>
         Enables decoding of prepared transactions. This option may only be specified with
-        <option>--create-slot</option>
+        <option>--create-slot</option>.
        </para>
        </listitem>
      </varlistentry>
index a81583191c117dc9a520b43de116a3ed2ccb7b98..374d8d8715c051d06905b20fb76809fd5ce1e5ae 100644 (file)
@@ -659,7 +659,7 @@ PostgreSQL documentation
        <para>
         Do not output commands to select table access methods.
         With this option, all objects will be created with whichever
-        access method is the default during restore.
+        table access method is the default during restore.
        </para>
       </listitem>
      </varlistentry>
index 4592d6016a55150b919ae0c39fdd2ac3e4a47722..a9371e037bde56b2fa7f2350a68077c535007404 100644 (file)
@@ -117,7 +117,7 @@ PostgreSQL documentation
       <term><option>--fork=<replaceable>fork</replaceable></option></term>
       <listitem>
        <para>
-        If provided, only display records that modify blocks in the given fork.
+        Only display records that modify blocks in the given fork.
         The valid values are <literal>main</literal> for the main fork,
         <literal>fsm</literal> for the free space map,
         <literal>vm</literal> for the visibility map,
@@ -174,12 +174,13 @@ PostgreSQL documentation
         names, and exit.
        </para>
        <para>
-        Extensions may define custom resource managers, but pg_waldump does
+        Extensions may define custom resource managers, but
+        <application>pg_waldump</application> does
         not load the extension module and therefore does not recognize custom
         resource managers by name. Instead, you can specify the custom
         resource managers as <literal>custom###</literal> where
-        "<literal>###</literal>" is the three-digit resource manager ID. Names
-        of this form will always be considered valid.
+        <replaceable>###</replaceable> is the three-digit resource manager ID.
+        Names of this form will always be considered valid.
        </para>
       </listitem>
      </varlistentry>
index d3d6e3ef0783cb550c82ad706703257ed0e0dcdf..05d3f81619f16ba1a3de64124fcc723267a3b51a 100644 (file)
@@ -229,7 +229,8 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
             data is generated in <command>pgbench</command> client and then
             sent to the server. This uses the client/server bandwidth
             extensively through a <command>COPY</command>.
-            <command>pgbench</command> uses the FREEZE option with version 14 or later
+            <command>pgbench</command> uses the <option>FREEZE</option> option
+            with version 14 or later
             of <productname>PostgreSQL</productname> to speed up
             subsequent <command>VACUUM</command>, except on the
             <literal>pgbench_accounts</literal> table if partitions are
@@ -1118,7 +1119,8 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
     each SQL command on a single line ending with a semicolon.
    </para>
    <para>
-    It is assumed that pgbench scripts do not contain incomplete blocks of SQL
+    It is assumed that <application>pgbench</application> scripts do not contain
+    incomplete blocks of SQL
     transactions. If at runtime the client reaches the end of the script without
     completing the last transaction block, it will be aborted.
    </para>
@@ -2636,7 +2638,7 @@ END;
   </para>
 
   <para>
-   Here is some example output generated with these options:
+   Here is some example output generated with this option:
 <screen>
 <userinput>pgbench --aggregate-interval=10 --time=20 --client=10 --log --rate=1000 --latency-limit=10 --failures-detailed --max-tries=10 test</userinput>