8000 doc: Missing markup, punctuation and wordsmithing · postgrespro/postgres@7b2822e · GitHub
[go: up one dir, main page]
Skip to content

Commit 7b2822e

Browse files
danielgustafssondanielgustafsson
committed
doc: Missing markup, punctuation and wordsmithing
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
1 parent 9c73395 commit 7b2822e

16 files changed

+38
-34
lines changed

‎doc/src/sgml/catalogs.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8041,7 +8041,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
80418041
</para>
80428042
<para>
80438043
If true, the associated replication slots (i.e. the main slot and the
8044-
table sync slots) in the upstream database are enabled to be
8044+
table synchronization slots) in the upstream database are enabled to be
80458045
synchronized to the standbys
80468046
</para></entry>
80478047
</row>

‎doc/src/sgml/charset.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ SELECT * FROM test1 ORDER BY a || b COLLATE "fr_FR";
862862
This SQL standard collation sorts using the Unicode Collation
863863
Algorithm with the Default Unicode Collation Element Table. It is
864864
available in all encodings. ICU support is required to use this
865-
collation, and behavior may change if Postgres is built with a
865+
collation, and behavior may change if <productname>PostgreSQL</productname> is built with a
866866
different version of ICU. (This collation has the same behavior as
867867
the ICU root locale; see <xref
868868
linkend="collation-managing-predefined-icu-und-x-icu"/>.)
@@ -897,7 +897,7 @@ SELECT * FROM test1 ORDER BY a || b COLLATE "fr_FR";
897897
expressions), it uses the POSIX Compatible variant of Unicode <ulink
898898
url="https://www.unicode.org/reports/tr18/#Compatibility_Properties">Compatibility
899899
Properties</ulink>. Behavior is efficient and stable within a
900-
<productname>Postgres</productname> major version. This collation is
900+
<productname>PostgreSQL</productname> major version. This collation is
901901
only available for encoding <literal>UTF8</literal>.
902902
</para>
903903
</listitem>

‎doc/src/sgml/config.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -708,7 +708,7 @@ include_dir 'conf.d'
708708
</para>
709709

710710
<para>
711-
PostgreSQL sizes certain resources based directly on the value of
711+
<productname>PostgreSQL</productname> sizes certain resources based directly on the value of
712712
<varname>max_connections</varname>. Increasing its value leads to
713713
higher allocation of those resources, including shared memory.
714714
</para>
@@ -6422,7 +6422,7 @@ SELECT * FROM parent WHERE key = 2400;
64226422
</para>
64236423
<para>
64246424
If <systemitem>csvlog</systemitem> is included in <varname>log_destination</varname>,
6425-
log entries are output in <quote>comma separated
6425+
log entries are output in <quote>comma-separated
64266426
value</quote> (<acronym>CSV</acronym>) format, which is convenient for
64276427
loading logs into programs.
64286428
See <xref linkend="runtime-config-logging-csvlog"/> for details.
@@ -10838,7 +10838,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
1083810838
Turning this setting off is intended for environments where the
1083910839
configuration of <productname>PostgreSQL</productname> is managed by
1084010840
some external tool.
10841-
In such environments, a well intentioned superuser might
10841+
In such environments, a well-intentioned superuser might
1084210842
<emphasis>mistakenly</emphasis> use <command>ALTER SYSTEM</command>
1084310843
to change the configuration instead of using the external tool.
1084410844
This might result in unintended behavior, such as the external tool

‎doc/src/sgml/func.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21437,7 +21437,7 @@ SELECT NULLIF(value, '(none)') ...
2143721437
</para>
2143821438
<para>
2143921439
Extracts the lower bound of the multirange (<literal>NULL</literal> if the
21440-
multirange is empty has no lower bound).
21440+
multirange is empty or has no lower bound).
2144121441
</para>
2144221442
<para>
2144321443
<literal>lower('{[1.1,2.2)}'::nummultirange)</literal>

‎doc/src/sgml/libpq.sgml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -545,9 +545,9 @@ int PQsocketPoll(int sock, int forRead, int forWrite,
545545
the Unix epoch (that is, <type>time_t</type> times 1 million).
546546
Timeout is infinite if <parameter>end_time</parameter>
547547
is <literal>-1</literal>. Timeout is immediate (no blocking) if
548-
end_time is <literal>0</literal> (or indeed, any time before now).
549-
Timeout values can be calculated conveniently by adding the desired
550-
number of microseconds to the result of
548+
<parameter>end_time</parameter> is <literal>0</literal> (or indeed, any
549+
time before now). Timeout values can be calculated conveniently by
550+
adding the desired number of microseconds to the result of
551551
<xref linkend="libpq-PQgetCurrentTimeUSec"/>.
552552
Note that the underlying system calls may have less than microsecond
553553
precision, so that the actual delay may be imprecise.
@@ -1830,11 +1830,12 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
18301830
<term><literal>direct</literal></term>
18311831
<listitem>
18321832
<para>
1833-
start SSL handshake directly after establishing the TCP/IP
1834-
connection. This is only allowed with sslmode=require or higher,
1835-
because the weaker settings could lead to unintended fallback to
1836-
plaintext authentication when the server does not support direct
1837-
SSL handshake.
1833+
start SSL handshake directly after establishing the TCP/IP
1834+
connection. This is only allowed with
1835+
<literal>sslmode=require</literal> or higher, because the weaker
1836+
settings could lead to unintended fallback to plaintext
1837+
authentication when the server does not support direct SSL
1838+
handshake.
18381839
</para>
18391840
</listitem>
18401841
</varlistentry>
@@ -9582,7 +9583,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
95829583
<para>
95839584
For backwards compatibility with earlier versions of PostgreSQL, if a
95849585
root CA file exists, the behavior of
9585-
<literal>sslmode</literal>=<literal>require</literal> will be the same
9586+
<literal>sslmode=require</literal> will be the same
95869587
as that of <literal>verify-ca</literal>, meaning the server certificate
95879588
is validated against the CA. Relying on this behavior is discouraged,
95889589
and applications that need certificate validation should always use

‎doc/src/sgml/protocol.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3265,7 +3265,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
32653265
</term>
32663266
<listitem>
32673267
<para>
3268-
Comma separated list of publication names for which to subscribe
3268+
Comma-separated list of publication names for which to subscribe
32693269
(receive changes). The individual publication names are treated
32703270
as standard objects names and can be quoted the same as needed.
32713271
At least one publication name is required.
@@ -3330,8 +3330,9 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
33303330
</term>
33313331
<listitem>
33323332
<para>
3333-
Option to send changes by their origin. Possible values are "none"
3334-
to only send the changes that have no origin associated, or "any"
3333+
Option to send changes by their origin. Possible values are
3334+
<literal>none</literal> to only send the changes that have no origin
3335+
associated, or <literal>any</literal>
33353336
to send the changes regardless of their origin. This can be used
33363337
to avoid loops (infinite replication of the same data) among
33373338
replication nodes.

‎doc/src/sgml/ref/alter_table.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,8 +1123,8 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
11231123
</para>
11241124

11251125
<para>
1126-
All the forms of ALTER TABLE that act on a single table, except
1127-
<literal>RENAME</literal>, <literal>SET SCHEMA</literal>,
1126+
All the forms of <command>ALTER TABLE</command> that act on a single table,
1127+
except <literal>RENAME</literal>, <literal>SET SCHEMA</literal>,
11281128
<literal>ATTACH PARTITION</literal>, and
11291129
<literal>DETACH PARTITION</literal> can be combined into
11301130
a list of multiple alterations to be applied together. For example, it

‎doc/src/sgml/ref/copy.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
427427
<term><literal>LOG_VERBOSITY</literal></term>
428428
<listitem>
429429
<para>
430-
Specify the amount of messages emitted by a <command>COPY</command>
430+
Specifies the amount of messages emitted by a <command>COPY</command>
431431
command: <literal>default</literal> or <literal>verbose</literal>. If
432432
<literal>verbose</literal> is specified, additional messages are emitted
433433
during processing.
@@ -779,7 +779,7 @@ COPY <replaceable class="parameter">count</replaceable>
779779
<title>CSV Format</title>
780780

781781
<para>
782-
This format option is used for importing and exporting the Comma
782+
This format option is used for importing and exporting the Comma-
783783
Separated Value (<literal>CSV</literal>) file format used by many other
784784
programs, such as spreadsheets. Instead of the escaping rules used by
785785
<productname>PostgreSQL</productname>'s standard text format, it

‎doc/src/sgml/ref/create_subscription.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
185185

186186
<para>
187187
When setting <literal>slot_name</literal> to a valid name and
188-
<literal>create_slot</literal> to false, the
188+
<literal>create_slot</literal> to <literal>false</literal>, the
189189
<literal>failover</literal> property value of the named slot may
190190
differ from the counterpart <literal>failover</literal> parameter
191191
specified in the subscription. Always ensure the slot property
@@ -474,7 +474,8 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
474474
<para>
475475
If any table in the publication has a <literal>WHERE</literal> clause, rows
476476
for which the <replaceable class="parameter">expression</replaceable>
477-
evaluates to false or null will not be published. If the subscription has
477+
evaluates to <literal>false</literal> or <literal>NULL</literal> will not be
478+
published. If the subscription has
478479
several publications in which the same table has been published with
479480
different <literal>WHERE</literal> clauses, a row will be published if any
480481
of the expressions (referring to that publish operation) are satisfied. In

‎doc/src/sgml/ref/pgupgrade.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ PostgreSQL documentation
6767
</para>
6868

6969
<para>
70-
pg_upgrade supports upgrades from 9.2.X and later to the current
70+
<application>pg_upgrade</application> supports upgrades from 9.2.X and later to the current
7171
major release of <productname>PostgreSQL</productname>, including snapshot and beta releases.
7272
</para>
7373
</refsect1>

0 commit comments

Comments
 (0)
0