Dear all,
I have prepared a patch containing some minor inconsistencies in the
documentation. Please, take a look.
The inconsistencies were noticed by: Ekaterina Kiryanova, Elena
Indrupskaya, Maxim Yablokov, Anna Uraskova, Elena Karavaeva, and me.
We will be looking forward to your feedback.
The patch shall be applied to the REL_17_STABLE branch.
--
Regards,
Oleg Sibiryakov
Technical Writer
Postgres Professional, The Russian Postgres Company
https://postgrespro.ru
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index a63cc71efa2..7a905fd6a3a 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -8029,7 +8029,7 @@ SCRAM-SHA-256$<replaceable><iteration count></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>
diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml
index 834cb30c85a..a76e9579a14 100644
--- a/doc/src/sgml/charset.sgml
+++ b/doc/src/sgml/charset.sgml
@@ -382,8 +382,8 @@ initdb --locale-provider=icu --icu-locale=en
</para>
<para>
The <literal>C</literal> locale behavior is identical to the
- <literal>C</literal> locale in the libc provider. When using this
- locale, the behavior may depend on the database encoding.
+ <literal>C</literal> locale in the <literal>libc</literal> provider. When
+ using this locale, the behavior may depend on the database encoding.
</para>
<para>
The <literal>C.UTF-8</literal> locale is available only for when the
@@ -400,7 +400,7 @@ initdb --locale-provider=icu --icu-locale=en
<listitem>
<para>
The <literal>icu</literal> provider uses the external
- ICU<indexterm><primary>ICU</primary></indexterm>
+ <indexterm><primary>ICU</primary></indexterm>
library. <productname>PostgreSQL</productname> must have been
configured with support.
</para>
@@ -862,8 +862,9 @@ 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
- different version of ICU. (This collation has the same behavior as
+ 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"/>.)
</para>
@@ -897,7 +898,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>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 7c60aeab4f6..2027308f89f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -708,9 +708,10 @@ include_dir 'conf.d'
</para>
<para>
- PostgreSQL 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.
+ <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>
<para>
@@ -9384,7 +9385,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
<para>
If <varname>transaction_timeout</varname> is shorter or equal to
<varname>idle_in_transaction_session_timeout</varname> or <varname>statement_timeout</varname>
- then the longer timeout is ignored.
+ then the longer timeout is ignored.
</para>
<para>
@@ -10842,7 +10843,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
diff --git a/doc/src/sgml/ddl.sgml b/doc/src/sgml/ddl.sgml
index 220683b5eb4..1d2987e628d 100644
--- a/doc/src/sgml/ddl.sgml
+++ b/doc/src/sgml/ddl.sgml
@@ -313,7 +313,7 @@ INSERT INTO people (id, name, address) VALUE (<emphasis>DEFAULT</emphasis>, 'C',
<para>
The data type of an identity column must be one of the data types supported
- by sequences. (See <xref linkend="sql-createsequence"/>.) The properties
+ by sequences (see <xref linkend="sql-createsequence"/>). The properties
of the associated sequence may be specified when creating an identity
column (see <xref linkend="sql-createtable"/>) or changed afterwards (see
<xref linkend="sql-altertable"/>).
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 03b63f74191..b876c5cf939 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -21381,7 +21381,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>
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 068ee60771c..855806b739b 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -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.
@@ -1831,8 +1831,9 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
<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
+ 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>
@@ -9556,7 +9557,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
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 1b27d0a5479..659e77bcf2d 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -3247,7 +3247,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.
@@ -3312,11 +3312,11 @@ 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"
- to send the changes regardless of their origin. This can be used
- to avoid loops (infinite replication of the same data) among
- replication nodes.
+ 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.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml
index 1a49f321cf7..3867a826e5f 100644
--- a/doc/src/sgml/ref/alter_table.sgml
+++ b/doc/src/sgml/ref/alter_table.sgml
@@ -1121,8 +1121,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
diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml
index 1518af8a045..9ec9b85b3f5 100644
--- a/doc/src/sgml/ref/copy.sgml
+++ b/doc/src/sgml/ref/copy.sgml
@@ -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.
diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml
index 7653cb902ee..af4eb1e4313 100644
--- a/doc/src/sgml/ref/create_database.sgml
+++ b/doc/src/sgml/ref/create_database.sgml
@@ -223,9 +223,9 @@ CREATE DATABASE <replaceable class="parameter">name</replaceable>
<term><replaceable class="parameter">builtin_locale</replaceable></term>
<listitem>
<para>
- Specifies the builtin provider locale for the database default
- collation order and character classification, overriding the setting
- <xref linkend="create-database-locale"/>. The <link
+ Specifies the <literal>builtin</literal> provider locale for the database
+ default collation order and character classification, overriding the
+ setting <xref linkend="create-database-locale"/>. The <link
linkend="create-database-locale-provider">locale provider</link> must
be <literal>builtin</literal>. The default is the setting of <xref
linkend="create-database-locale"/> if specified; otherwise the same
diff --git a/doc/src/sgml/ref/create_subscription.sgml b/doc/src/sgml/ref/create_subscription.sgml
index 740b7d94210..674ed23a02a 100644
--- a/doc/src/sgml/ref/create_subscription.sgml
+++ b/doc/src/sgml/ref/create_subscription.sgml
@@ -129,8 +129,8 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
Since no connection is made when this option is
<literal>false</literal>, no tables are subscribed. To initiate
replication, you must manually create the replication slot, enable
- the failover if required, enable the subscription, and refresh the
- subscription. See
+ the <literal>failover</literal> if required, enable the subscription,
+ and refresh the subscription. See
<xref linkend="logical-replication-subscription-examples-deferred-slot"/>
for examples.
</para>
@@ -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,13 +474,13 @@ 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
- 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
- the case of different <literal>WHERE</literal> clauses, if one of the
- publications has no <literal>WHERE</literal> clause (referring to that
- publish operation) or the publication is declared as
+ 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 wit different <literal>WHERE</literal> clauses, a
+ row will be published if an of the expressions (referring to that publish
+ operation) are satisfied. I the case of different <literal>WHERE</literal>
+ clauses, if one of the publications has no <literal>WHERE</literal> clause
+ (referring to that publish operation) or the publication is declared as
<link linkend="sql-createpublication-params-for-all-tables"><literal>FOR ALL TABLES</literal></link>
or <link linkend="sql-createpublication-params-for-tables-in-schema"><literal>FOR TABLES IN SCHEMA</literal></link>,
rows are always published regardless of the definition of the other
diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml
index f19306e7760..975b2a1992b 100644
--- a/doc/src/sgml/ref/create_table.sgml
+++ b/doc/src/sgml/ref/create_table.sgml
@@ -2330,7 +2330,7 @@ CREATE TABLE cities_partdef
<para>
Currently, <productname>PostgreSQL</productname> does not record names
- for not-null constraints at all, so they are not
+ for <literal>NOT NULL</literal> constraints at all, so they are not
subject to the uniqueness restriction. This might change in a future
release.
</para>
diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml
index 5c4e0465ed9..125a04d9256 100644
--- a/doc/src/sgml/ref/createdb.sgml
+++ b/doc/src/sgml/ref/createdb.sgml
@@ -154,8 +154,8 @@ PostgreSQL documentation
<term><option>--builtin-locale=<replaceable class="parameter">locale</replaceable></option></term>
<listitem>
<para>
- Specifies the locale name when the builtin provider is used. Locale support
- is described in <xref linkend="locale"/>.
+ Specifies the locale name when the <literal>builtin</literal> provider
+ is used. Locale support is described in <xref linkend="locale"/>.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml
index bdd613e77ff..883d3515921 100644
--- a/doc/src/sgml/ref/initdb.sgml
+++ b/doc/src/sgml/ref/initdb.sgml
@@ -324,8 +324,8 @@ PostgreSQL documentation
<term><option>--builtin-locale=<replaceable>locale</replaceable></option></term>
<listitem>
<para>
- Specifies the locale name when the builtin provider is used. Locale support
- is described in <xref linkend="locale"/>.
+ Specifies the locale name when the <literal>builtin</literal> provider
+ is used. Locale support is described in <xref linkend="locale"/>.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/ref/merge.sgml b/doc/src/sgml/ref/merge.sgml
index 97b34b9fcaf..aa83a500b43 100644
--- a/doc/src/sgml/ref/merge.sgml
+++ b/doc/src/sgml/ref/merge.sgml
@@ -263,9 +263,10 @@ DELETE
<para>
If both <literal>WHEN NOT MATCHED BY SOURCE</literal> and
<literal>WHEN NOT MATCHED [BY TARGET]</literal> clauses are specified,
- the <command>MERGE</command> command will perform a <literal>FULL</literal>
- join between <replaceable class="parameter">data_source</replaceable>
- and the target table. For this to work, at least one
+ the <command>MERGE</command> command will perform a
+ <literal>FULL JOIN</literal> between
+ <replaceable class="parameter">data_source</replaceable> and the target
+ table. For this to work, at least one
<replaceable class="parameter">join_condition</replaceable> subexpression
must use an operator that can support a hash join, or all of the
subexpressions must use operators that can support a merge join.
diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index 82d0c8e0088..e3e83b2ddc8 100644
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -245,9 +245,9 @@ PostgreSQL documentation
that <application>pg_basebackup</application> is using, so that
streaming replication and <link linkend="logicaldecoding-replication-slots-synchronization">
logical replication slot synchronization</link> will use the same
- settings later on. The dbname will be recorded only if the dbname was
- specified explicitly in the connection string or <link linkend="libpq-envars">
- environment variable</link>.
+ settings later on. <literal>dbname</literal> will be recorded only
+ if it was specified explicitly in the connection string or
+ <link linkend="libpq-envars">environment variable</link>.
</para>
</listitem>
diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml
index 9877f2f01c6..77019bab8fc 100644
--- a/doc/src/sgml/ref/pgupgrade.sgml
+++ b/doc/src/sgml/ref/pgupgrade.sgml
@@ -67,8 +67,9 @@ PostgreSQL documentation
</para>
<para>
- pg_upgrade supports upgrades from 9.2.X and later to the current
- major release of <productname>PostgreSQL</productname>, including snapshot and beta releases.
+ <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>
diff --git a/doc/src/sgml/sepgsql.sgml b/doc/src/sgml/sepgsql.sgml
index 1b848f1977c..954b461c32a 100644
--- a/doc/src/sgml/sepgsql.sgml
+++ b/doc/src/sgml/sepgsql.sgml
@@ -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
diff --git a/doc/src/sgml/syntax.sgml b/doc/src/sgml/syntax.sgml
index 4dfbbd08626..916189a7d68 100644
--- a/doc/src/sgml/syntax.sgml
+++ b/doc/src/sgml/syntax.sgml
@@ -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>
diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml
index 8c18bea902f..db63d094ff2 100644
--- a/doc/src/sgml/system-views.sgml
+++ b/doc/src/sgml/system-views.sgml
@@ -2548,7 +2548,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>
@@ -3907,7 +3907,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>
diff --git a/doc/src/sgml/trigger.sgml b/doc/src/sgml/trigger.sgml
index 31626536a2e..f998e03acd3 100644
--- a/doc/src/sgml/trigger.sgml
+++ b/doc/src/sgml/trigger.sgml
@@ -357,10 +357,10 @@
<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.
- 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
+ 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
be to break referential integrity. It is the trigger programmer's
responsibility to avoid that.
</para>
diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml
index 07a16247d76..9cf65ec749c 100644
--- a/doc/src/sgml/user-manag.sgml
+++ b/doc/src/sgml/user-manag.sgml
@@ -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
diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml
index d5df65bc693..2eb282ab000 100644
--- a/doc/src/sgml/wal.sgml
+++ b/doc/src/sgml/wal.sgml
@@ -679,11 +679,11 @@
<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.
