Skip to content

Commit 9436041

Browse files
committed
Copy editing: fix a bunch of misspellings and poor wording.
99% of this is docs, but also a couple of comments. No code changes. Justin Pryzby Discussion: https://postgr.es/m/20200919175804.GE30557@telsasoft.com
1 parent 80fc96e commit 9436041

24 files changed

+44
-42
lines changed

doc/src/sgml/btree.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
642642
</para>
643643
<para>
644644
Deduplication works by periodically merging groups of duplicate
645-
tuples together, forming a single posting list tuple for each
645+
tuples together, forming a single <firstterm>posting list</firstterm> tuple for each
646646
group. The column key value(s) only appear once in this
647647
representation. This is followed by a sorted array of
648648
<acronym>TID</acronym>s that point to rows in the table. This

doc/src/sgml/catalogs.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7298,7 +7298,8 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
72987298
of statistics accumulated for this statistics object by
72997299
<xref linkend="sql-analyze"/>.
73007300
A zero value indicates that no statistics should be collected.
7301-
A negative value says to use the system default statistics target.
7301+
A negative value says to use the maximum of the statistics targets of
7302+
the referenced columns, if set, or the system default statistics target.
73027303
Positive values of <structfield>stxstattarget</structfield>
73037304
determine the target number of <quote>most common values</quote>
73047305
to collect.

doc/src/sgml/config.sgml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3813,7 +3813,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
38133813
servers or streaming base backup clients (i.e., the maximum number of
38143814
simultaneously running WAL sender processes). The default is
38153815
<literal>10</literal>. The value <literal>0</literal> means
3816-
replication is disabled. Abrupt streaming client disconnection might
3816+
replication is disabled. Abrupt disconnection of a streaming client might
38173817
leave an orphaned connection slot behind until a timeout is reached,
38183818
so this parameter should be set slightly higher than the maximum
38193819
number of expected clients so disconnected clients can immediately
@@ -3902,9 +3902,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
39023902
slots</link> are allowed to retain in the <filename>pg_wal</filename>
39033903
directory at checkpoint time.
39043904
If <varname>max_slot_wal_keep_size</varname> is -1 (the default),
3905-
replication slots retain unlimited amount of WAL files. If
3906-
restart_lsn of a replication slot gets behind more than that megabytes
3907-
from the current LSN, the standby using the slot may no longer be able
3905+
replication slots may retain an unlimited amount of WAL files. Otherwise, if
3906+
restart_lsn of a replication slot falls behind the current LSN by more
3907+
than the given size, the standby using the slot may no longer be able
39083908
to continue replication due to removal of required WAL files. You
39093909
can see the WAL availability of replication slots
39103910
in <link linkend="view-pg-replication-slots">pg_replication_slots</link>.
@@ -6847,9 +6847,9 @@ log_line_prefix = '%m [%p] %q%u@%d/%a '
68476847
</term>
68486848
<listitem>
68496849
<para>
6850-
If greater than zero, each bind parameter value reported in
6851-
non-error statement-logging messages is trimmed to this many bytes.
6852-
Zero disables logging bind parameters with statements.
6850+
If greater than zero, each bind parameter value logged with a
6851+
non-error statement-logging message is trimmed to this many bytes.
6852+
Zero disables logging of bind parameters for non-error statement logs.
68536853
<literal>-1</literal> (the default) allows bind parameters to be
68546854
logged in full.
68556855
If this value is specified without units, it is taken as bytes.
@@ -8224,10 +8224,10 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
82248224
a regular <command>VACUUM</command> in that it visits every page that might
82258225
contain unfrozen XIDs or MXIDs, not just those that might contain dead
82268226
tuples. The default is 150 million transactions. Although users can
8227-
set this value anywhere from zero to two billions, <command>VACUUM</command>
8227+
set this value anywhere from zero to two billion, <command>VACUUM</command>
82288228
will silently limit the effective value to 95% of
82298229
<xref linkend="guc-autovacuum-freeze-max-age"/>, so that a
8230-
periodical manual <command>VACUUM</command> has a chance to run before an
8230+
periodic manual <command>VACUUM</command> has a chance to run before an
82318231
anti-wraparound autovacuum is launched for the table. For more
82328232
information see
82338233
<xref linkend="vacuum-for-wraparound"/>.
@@ -8271,10 +8271,10 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
82718271
a regular <command>VACUUM</command> in that it visits every page that might
82728272
contain unfrozen XIDs or MXIDs, not just those that might contain dead
82738273
tuples. The default is 150 million multixacts.
8274-
Although users can set this value anywhere from zero to two billions,
8274+
Although users can set this value anywhere from zero to two billion,
82758275
<command>VACUUM</command> will silently limit the effective value to 95% of
82768276
<xref linkend="guc-autovacuum-multixact-freeze-max-age"/>, so that a
8277-
periodical manual <command>VACUUM</command> has a chance to run before an
8277+
periodic manual <command>VACUUM</command> has a chance to run before an
82788278
anti-wraparound is launched for the table.
82798279
For more information see <xref linkend="vacuum-for-multixact-wraparound"/>.
82808280
</para>

doc/src/sgml/ddl.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3992,7 +3992,7 @@ ALTER TABLE measurement ATTACH PARTITION measurement_y2008m02
39923992
Before running the <command>ATTACH PARTITION</command> command, it is
39933993
recommended to create a <literal>CHECK</literal> constraint on the table to
39943994
be attached matching the desired partition constraint. That way,
3995-
the system will be able to skip the scan to validate the implicit
3995+
the system will be able to skip the scan which is otherwise needed to validate the implicit
39963996
partition constraint. Without the <literal>CHECK</literal> constraint,
39973997
the table will be scanned to validate the partition constraint while
39983998
holding an <literal>ACCESS EXCLUSIVE</literal> lock on that partition

doc/src/sgml/func.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15626,11 +15626,11 @@ table2-mapping
1562615626
<literal>'use_json_null'</literal>.
1562715627
</para>
1562815628
<para>
15629-
<literal>jsonb_set_lax('[{"f1":1,"f2":null},2,null,3]', '{0,f1}',null)</literal>
15629+
<literal>jsonb_set_lax('[{"f1":1,"f2":null},2,null,3]', '{0,f1}', null)</literal>
1563015630
<returnvalue>[{"f1":null,"f2":null},2,null,3]</returnvalue>
1563115631
</para>
1563215632
<para>
15633-
<literal>jsonb_set_lax('[{"f1":99,"f2":null},2]', '{0,f3}',null, true, 'return_target')</literal>
15633+
<literal>jsonb_set_lax('[{"f1":99,"f2":null},2]', '{0,f3}', null, true, 'return_target')</literal>
1563415634
<returnvalue>[{"f1": 99, "f2": null}, 2]</returnvalue>
1563515635
</para></entry>
1563615636
</row>

doc/src/sgml/libpq.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1227,7 +1227,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
12271227
<term><literal>connect_timeout</literal></term>
12281228
<listitem>
12291229
<para>
1230-
Maximum wait for connection, in seconds (write as a decimal integer,
1230+
Maximum time to wait while connecting, in seconds (write as a decimal integer,
12311231
e.g., <literal>10</literal>). Zero, negative, or not specified means
12321232
wait indefinitely. The minimum allowed timeout is 2 seconds, therefore
12331233
a value of <literal>1</literal> is interpreted as <literal>2</literal>.

doc/src/sgml/logical-replication.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@
403403
<listitem>
404404
<para>
405405
Replication is only supported by tables, including partitioned tables.
406-
Attempts to replicate other types of relations such as views, materialized
406+
Attempts to replicate other types of relations, such as views, materialized
407407
views, or foreign tables, will result in an error.
408408
</para>
409409
</listitem>

doc/src/sgml/monitoring.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6089,8 +6089,8 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
60896089
<entry><literal>waiting for checkpoint to finish</literal></entry>
60906090
<entry>
60916091
The WAL sender process is currently performing
6092-
<function>pg_start_backup</function> to set up for
6093-
taking a base backup, and waiting for backup start
6092+
<function>pg_start_backup</function> to prepare to
6093+
take a base backup, and waiting for the start-of-backup
60946094
checkpoint to finish.
60956095
</entry>
60966096
</row>

doc/src/sgml/protocol.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2587,7 +2587,7 @@ The commands accepted in replication mode are:
25872587
and sent along with the backup. The manifest is a list of every
25882588
file present in the backup with the exception of any WAL files that
25892589
may be included. It also stores the size, last modification time, and
2590-
an optional checksum for each file.
2590+
optionally a checksum for each file.
25912591
A value of <literal>force-encode</literal> forces all filenames
25922592
to be hex-encoded; otherwise, this type of encoding is performed only
25932593
for files whose names are non-UTF8 octet sequences.
@@ -2603,7 +2603,7 @@ The commands accepted in replication mode are:
26032603
<term><literal>MANIFEST_CHECKSUMS</literal> <replaceable>checksum_algorithm</replaceable></term>
26042604
<listitem>
26052605
<para>
2606-
Specifies the algorithm that should be applied to each file included
2606+
Specifies the checksum algorithm that should be applied to each file included
26072607
in the backup manifest. Currently, the available
26082608
algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>,
26092609
<literal>SHA224</literal>, <literal>SHA256</literal>,

doc/src/sgml/ref/alter_statistics.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@ ALTER STATISTICS <replaceable class="parameter">name</replaceable> SET STATISTIC
101101
The statistic-gathering target for this statistics object for subsequent
102102
<xref linkend="sql-analyze"/> operations.
103103
The target can be set in the range 0 to 10000; alternatively, set it
104-
to -1 to revert to using the system default statistics
104+
to -1 to revert to using the maximum of the statistics target of the
105+
referenced columns, if set, or the system default statistics
105106
target (<xref linkend="guc-default-statistics-target"/>).
106107
For more information on the use of statistics by the
107108
<productname>PostgreSQL</productname> query planner, refer to

doc/src/sgml/ref/alter_table.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
669669
When applied to a partitioned table, nothing is moved, but any
670670
partitions created afterwards with
671671
<command>CREATE TABLE PARTITION OF</command> will use that tablespace,
672-
unless the <literal>TABLESPACE</literal> clause is used to override it.
672+
unless overridden by a <literal>TABLESPACE</literal> clause.
673673
</para>
674674

675675
<para>

doc/src/sgml/ref/pg_basebackup.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ PostgreSQL documentation
368368
</para>
369369
<para>
370370
The following command-line options control the generation of the
371-
backup and the running of the program:
371+
backup and the invocation of the program:
372372

373373
<variablelist>
374374
<varlistentry>
@@ -540,7 +540,7 @@ PostgreSQL documentation
540540
of each file for users who wish to verify that the backup has not been
541541
tampered with, while the CRC32C algorithm provides a checksum that is
542542
much faster to calculate; it is good at catching errors due to accidental
543-
changes but is not resistant to targeted modifications. Note that, to
543+
changes but is not resistant to malicious modifications. Note that, to
544544
be useful against an adversary who has access to the backup, the backup
545545
manifest would need to be stored securely elsewhere or otherwise
546546
verified not to have been modified since the backup was taken.

doc/src/sgml/ref/pg_dump.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ PostgreSQL documentation
322322
<listitem>
323323
<para>
324324
Run the dump in parallel by dumping <replaceable class="parameter">njobs</replaceable>
325-
tables simultaneously. This option reduces the time of the dump but it also
325+
tables simultaneously. This option may reduce the time needed to perform the dump but it also
326326
increases the load on the database server. You can only use this option with the
327327
directory output format because this is the only output format where multiple processes
328328
can write their data at the same time.

doc/src/sgml/ref/pg_rewind.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ PostgreSQL documentation
211211
<command>pg_rewind</command> to return without waiting, which is
212212
faster, but means that a subsequent operating system crash can leave
213213
the synchronized data directory corrupt. Generally, this option is
214-
useful for testing but should not be used when creating a production
214+
useful for testing but should not be used on a production
215215
installation.
216216
</para>
217217
</listitem>
@@ -322,7 +322,7 @@ GRANT EXECUTE ON function pg_catalog.pg_read_binary_file(text, bigint, bigint, b
322322
<para>
323323
When executing <application>pg_rewind</application> using an online
324324
cluster as source which has been recently promoted, it is necessary
325-
to execute a <command>CHECKPOINT</command> after promotion so as its
325+
to execute a <command>CHECKPOINT</command> after promotion such that its
326326
control file reflects up-to-date timeline information, which is used by
327327
<application>pg_rewind</application> to check if the target cluster
328328
can be rewound using the designated source cluster.

doc/src/sgml/ref/pgbench.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -812,8 +812,8 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
812812
<title>Common Options</title>
813813

814814
<para>
815-
<application>pgbench</application> accepts the following command-line
816-
common arguments:
815+
<application>pgbench</application> also accepts the following common command-line
816+
arguments for connection parameters:
817817

818818
<variablelist>
819819

doc/src/sgml/ref/reindex.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ REINDEX [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] { IN
252252
<para>
253253
Reindexing a single index or table requires being the owner of that
254254
index or table. Reindexing a schema or database requires being the
255-
owner of that schema or database. Note that is therefore sometimes
255+
owner of that schema or database. Note specifically that it's thus
256256
possible for non-superusers to rebuild indexes of tables owned by
257257
other users. However, as a special exception, when
258258
<command>REINDEX DATABASE</command>, <command>REINDEX SCHEMA</command>

doc/src/sgml/ref/reindexdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,8 @@ PostgreSQL documentation
174174
<para>
175175
Execute the reindex commands in parallel by running
176176
<replaceable class="parameter">njobs</replaceable>
177-
commands simultaneously. This option reduces the time of the
178-
processing but it also increases the load on the database server.
177+
commands simultaneously. This option may reduce the processing time
178+
but it also increases the load on the database server.
179179
</para>
180180
<para>
181181
<application>reindexdb</application> will open

doc/src/sgml/ref/vacuumdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,8 @@ PostgreSQL documentation
155155
<para>
156156
Execute the vacuum or analyze commands in parallel by running
157157
<replaceable class="parameter">njobs</replaceable>
158-
commands simultaneously. This option reduces the time of the
159-
processing but it also increases the load on the database server.
158+
commands simultaneously. This option may reduce the processing time
159+
but it also increases the load on the database server.
160160
</para>
161161
<para>
162162
<application>vacuumdb</application> will open

doc/src/sgml/runtime.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2575,7 +2575,7 @@ openssl x509 -req -in server.csr -text -days 365 \
25752575
<para>
25762576
The <productname>PostgreSQL</productname> server will listen for both
25772577
normal and <acronym>GSSAPI</acronym>-encrypted connections on the same TCP
2578-
port, and will negotiate with any connecting client on whether to
2578+
port, and will negotiate with any connecting client whether to
25792579
use <acronym>GSSAPI</acronym> for encryption (and for authentication). By
25802580
default, this decision is up to the client (which means it can be
25812581
downgraded by an attacker); see <xref linkend="auth-pg-hba-conf"/> about

doc/src/sgml/sources.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ Hint: the addendum
518518
<title>Use of Quotes</title>
519519

520520
<para>
521-
Use quotes always to delimit file names, user-supplied identifiers, and
521+
Always use quotes to delimit file names, user-supplied identifiers, and
522522
other variables that might contain words. Do not use them to mark up
523523
variables that will not contain words (for example, operator names).
524524
</para>

src/backend/access/gin/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ leftmost leaf of the tree.
413413
Deletion algorithm keeps exclusive locks on left siblings of pages comprising
414414
currently investigated path. Thus, if current page is to be removed, all
415415
required pages to remove both downlink and rightlink are already locked. That
416-
evades potential right to left page locking order, which could deadlock with
416+
avoids potential right to left page locking order, which could deadlock with
417417
concurrent stepping right.
418418

419419
A search concurrent to page deletion might already have read a pointer to the

src/backend/utils/adt/jsonpath_exec.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* executeItemOptUnwrapTarget() function have 'unwrap' argument, which indicates
3636
* whether unwrapping of array is needed. When unwrap == true, each of array
3737
* members is passed to executeItemOptUnwrapTarget() again but with unwrap == false
38-
* in order to evade subsequent array unwrapping.
38+
* in order to avoid subsequent array unwrapping.
3939
*
4040
* All boolean expressions (predicates) are evaluated by executeBoolItem()
4141
* function, which returns tri-state JsonPathBool. When error is occurred

src/test/regress/expected/partition_join.out

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4567,7 +4567,7 @@ ANALYZE plt3_adv;
45674567
-- This tests that when merging partitions from plt1_adv and plt2_adv in
45684568
-- merge_list_bounds(), process_outer_partition() returns an already-assigned
45694569
-- merged partition when re-called with plt1_adv_p1 for the second list value
4570-
-- '0001' of that partitin
4570+
-- '0001' of that partition
45714571
EXPLAIN (COSTS OFF)
45724572
SELECT t1.a, t1.c, t2.a, t2.c, t3.a, t3.c FROM (plt1_adv t1 LEFT JOIN plt2_adv t2 ON (t1.c = t2.c)) FULL JOIN plt3_adv t3 ON (t1.c = t3.c) WHERE coalesce(t1.a, 0) % 5 != 3 AND coalesce(t1.a, 0) % 5 != 4 ORDER BY t1.c, t1.a, t2.a, t3.a;
45734573
QUERY PLAN

src/test/regress/sql/partition_join.sql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,7 @@ ANALYZE plt3_adv;
10901090
-- This tests that when merging partitions from plt1_adv and plt2_adv in
10911091
-- merge_list_bounds(), process_outer_partition() returns an already-assigned
10921092
-- merged partition when re-called with plt1_adv_p1 for the second list value
1093-
-- '0001' of that partitin
1093+
-- '0001' of that partition
10941094
EXPLAIN (COSTS OFF)
10951095
SELECT t1.a, t1.c, t2.a, t2.c, t3.a, t3.c FROM (plt1_adv t1 LEFT JOIN plt2_adv t2 ON (t1.c = t2.c)) FULL JOIN plt3_adv t3 ON (t1.c = t3.c) WHERE coalesce(t1.a, 0) % 5 != 3 AND coalesce(t1.a, 0) % 5 != 4 ORDER BY t1.c, t1.a, t2.a, t3.a;
10961096
SELECT t1.a, t1.c, t2.a, t2.c, t3.a, t3.c FROM (plt1_adv t1 LEFT JOIN plt2_adv t2 ON (t1.c = t2.c)) FULL JOIN plt3_adv t3 ON (t1.c = t3.c) WHERE coalesce(t1.a, 0) % 5 != 3 AND coalesce(t1.a, 0) % 5 != 4 ORDER BY t1.c, t1.a, t2.a, t3.a;

0 commit comments

Comments
 (0)