Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 609b065

Browse files
michaelpqmichaelpq
committed
Fix typos and grammar in documentation and code comments
Comment fixes are applied on HEAD, and documentation improvements are applied on back-branches where needed. Author: Justin Pryzby Discussion: https://postgr.es/m/[email protected] Backpatch-through: 9.6
1 parent 796092f commit 609b065

23 files changed

+53
-52
lines changed

‎doc/src/sgml/config.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2723,7 +2723,7 @@ include_dir 'conf.d'
27232723
Note that changing <varname>wal_level</varname> to
27242724
<literal>minimal</literal> makes any base backups taken before
27252725
unavailable for archive recovery and standby server, which may
2726-
lead to database loss.
2726+
lead to data loss.
27272727
</para>
27282728
<para>
27292729
In <literal>logical</literal> level, the same information is logged as
@@ -3098,7 +3098,7 @@ include_dir 'conf.d'
30983098
<listitem>
30993099
<para>
31003100
When this parameter is <literal>on</literal>, the <productname>PostgreSQL</productname>
3101-
server compresses a full page image written to WAL when
3101+
server compresses full page images written to WAL when
31023102
<xref linkend="guc-full-page-writes"/> is on or during a base backup.
31033103
A compressed page image will be decompressed during WAL replay.
31043104
The default value is <literal>off</literal>.
@@ -4137,7 +4137,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
41374137
On the subscriber side, specifies how many replication origins (see
41384138
<xref linkend="replication-origins"/>) can be tracked simultaneously,
41394139
effectively limiting how many logical replication subscriptions can
4140-
be created on the server. Setting it a lower value than the current
4140+
be created on the server. Setting it to a lower value than the current
41414141
number of tracked replication origins (reflected in
41424142
<link linkend="view-pg-replication-origin-status">pg_replication_origin_status</link>,
41434143
not <link linkend="catalog-pg-replication-origin">pg_replication_origin</link>)
@@ -7732,12 +7732,12 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
77327732
The <xref linkend="pgstatstatements"/> extension also requires a query
77337733
identifier to be computed. Note that an external module can
77347734
alternatively be used if the in-core query identifier computation
7735-
specification isn't acceptable. In this case, in-core computation
7735+
method is not acceptable. In this case, in-core computation
77367736
must be disabled. The default is <literal>off</literal>.
77377737
</para>
77387738
<note>
77397739
<para>
7740-
To ensure that a only one query identifier is calculated and
7740+
To ensure that only one query identifier is calculated and
77417741
displayed, extensions that calculate query identifiers should
77427742
throw an error if a query identifier has already been computed.
77437743
</para>

‎doc/src/sgml/func.sgml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3560,7 +3560,7 @@ repeat('Pg', 4) <returnvalue>PgPgPgPg</returnvalue>
35603560
<returnvalue>text</returnvalue>
35613561
</para>
35623562
<para>
3563-
Evaluate escaped Unicode characters in argument. Unicode characters
3563+
Evaluate escaped Unicode characters in the argument. Unicode characters
35643564
can be specified as
35653565
<literal>\<replaceable>XXXX</replaceable></literal> (4 hexadecimal
35663566
digits), <literal>\+<replaceable>XXXXXX</replaceable></literal> (6
@@ -24926,12 +24926,12 @@ SELECT collation for ('foo' COLLATE "de_DE");
2492624926
<returnvalue>boolean</returnvalue>
2492724927
</para>
2492824928
<para>
24929-
Requests to log the memory contexts whose backend process has
24930-
the specified process ID. These memory contexts will be logged at
24929+
Requests to log the memory contexts of the backend with the
24930+
specified process ID. These memory contexts will be logged at
2493124931
<literal>LOG</literal> message level. They will appear in
2493224932
the server log based on the log configuration set
2493324933
(See <xref linkend="runtime-config-logging"/> for more information),
24934-
but will not be sent to the client whatever the setting of
24934+
but will not be sent to the client regardless of
2493524935
<xref linkend="guc-client-min-messages"/>.
2493624936
Only superusers can request to log the memory contexts.
2493724937
</para></entry>
@@ -25037,7 +25037,7 @@ SELECT collation for ('foo' COLLATE "de_DE");
2503725037

2503825038
<para>
2503925039
<function>pg_log_backend_memory_contexts</function> can be used
25040-
to log the memory contexts of the backend process. For example,
25040+
to log the memory contexts of a backend process. For example:
2504125041
<programlisting>
2504225042
postgres=# SELECT pg_log_backend_memory_contexts(pg_backend_pid());
2504325043
pg_log_backend_memory_contexts
@@ -25061,8 +25061,8 @@ LOG: level: 1; TransactionAbortContext: 32768 total in 1 blocks; 32504 free (0
2506125061
LOG: level: 1; ErrorContext: 8192 total in 1 blocks; 7928 free (3 chunks); 264 used
2506225062
LOG: Grand total: 1651920 bytes in 201 blocks; 622360 free (88 chunks); 1029560 used
2506325063
</screen>
25064-
For more than 100 child contexts under the same parent one,
25065-
100 child contexts and a summary of the remaining ones will be logged.
25064+
If there are more than 100 child contexts under the same parent, the first
25065+
100 child contexts are logged, along with a summary of the remaining contexts.
2506625066
Note that frequent calls to this function could incur significant overhead,
2506725067
because it may generate a large number of log messages.
2506825068
</para>
@@ -25576,7 +25576,7 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup());
2557625576
Returns recovery pause state. The return values are <literal>
2557725577
not paused</literal> if pause is not requested, <literal>
2557825578
pause requested</literal> if pause is requested but recovery is
25579-
not yet paused and, <literal>paused</literal> if the recovery is
25579+
not yet paused, and <literal>paused</literal> if the recovery is
2558025580
actually paused.
2558125581
</para></entry>
2558225582
</row>

‎doc/src/sgml/logical-replication.sgml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -490,9 +490,9 @@
490490
any changes that happened during the initial data copy using standard
491491
logical replication. During this synchronization phase, the changes
492492
are applied and committed in the same order as they happened on the
493-
publisher. Once the synchronization is done, the control of the
493+
publisher. Once synchronization is done, control of the
494494
replication of the table is given back to the main apply process where
495-
the replication continues as normal.
495+
replication continues as normal.
496496
</para>
497497
</sect2>
498498
</sect1>
@@ -602,10 +602,9 @@
602602
</para>
603603

604604
<para>
605-
The subscriber also requires the <varname>max_replication_slots</varname>
606-
be set to configure how many replication origins can be tracked. In this
607-
case it should be set to at least the number of subscriptions that will be
608-
added to the subscriber, plus some reserve for table synchronization.
605+
<varname>max_replication_slots</varname> must also be set on the subscriber.
606+
It should be set to at least the number of subscriptions that will be added
607+
to the subscriber, plus some reserve for table synchronization.
609608
<varname>max_logical_replication_workers</varname> must be set to at least
610609
the number of subscriptions, again plus some reserve for the table
611610
synchronization. Additionally the <varname>max_worker_processes</varname>

‎doc/src/sgml/maintenance.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@
185185
never issue <command>VACUUM FULL</command>. In this approach, the idea
186186
is not to keep tables at their minimum size, but to maintain steady-state
187187
usage of disk space: each table occupies space equivalent to its
188-
minimum size plus however much space gets used up between vacuumings.
188+
minimum size plus however much space gets used up between vacuum runs.
189189
Although <command>VACUUM FULL</command> can be used to shrink a table back
190190
to its minimum size and return the disk space to the operating system,
191191
there is not much point in this if the table will just grow again in the

‎doc/src/sgml/monitoring.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5890,7 +5890,7 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
58905890
</para>
58915891
<para>
58925892
When creating an index on a partitioned table, this column is set to
5893-
the number of partitions on which the index has been completed.
5893+
the number of partitions on which the index has been created.
58945894
This field is <literal>0</literal> during a <literal>REINDEX</literal>.
58955895
</para></entry>
58965896
</row>

‎doc/src/sgml/perform.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1747,7 +1747,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
17471747
<xref linkend="guc-max-wal-senders"/> to zero.
17481748
But note that changing these settings requires a server restart,
17491749
and makes any base backups taken before unavailable for archive
1750-
recovery and standby server, which may lead to database loss.
1750+
recovery and standby server, which may lead to data loss.
17511751
</para>
17521752

17531753
<para>
@@ -1899,7 +1899,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
18991899
much faster. The following are configuration changes you can make
19001900
to improve performance in such cases. Except as noted below, durability
19011901
is still guaranteed in case of a crash of the database software;
1902-
only abrupt operating system stoppage creates a risk of data loss
1902+
only an abrupt operating system crash creates a risk of data loss
19031903
or corruption when these settings are used.
19041904

19051905
<itemizedlist>

‎doc/src/sgml/pgstatstatements.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@
406406
<note>
407407
<para>
408408
The following details about constant replacement and
409-
<structfield>queryid</structfield> only applies when <xref
409+
<structfield>queryid</structfield> only apply when <xref
410410
linkend="guc-compute-query-id"/> is enabled. If you use an external
411411
module instead to compute <structfield>queryid</structfield>, you
412412
should refer to its documentation for details.

‎doc/src/sgml/postgres-fdw.sgml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -551,8 +551,9 @@ OPTIONS (ADD password_required 'false');
551551
<title>Connection Management Options</title>
552552

553553
<para>
554-
By default all the open connections that <filename>postgres_fdw</filename>
555-
established to the foreign servers are kept in local session for re-use.
554+
By default, all connections that <filename>postgres_fdw</filename>
555+
establishes to foreign servers are kept open in the local session
556+
for re-use.
556557
</para>
557558

558559
<variablelist>
@@ -562,11 +563,11 @@ OPTIONS (ADD password_required 'false');
562563
<listitem>
563564
<para>
564565
This option controls whether <filename>postgres_fdw</filename> keeps
565-
the connections to the foreign server open so that the subsequent
566+
the connections to the foreign server open so that subsequent
566567
queries can re-use them. It can only be specified for a foreign server.
567568
The default is <literal>on</literal>. If set to <literal>off</literal>,
568569
all connections to this foreign server will be discarded at the end of
569-
transaction.
570+
each transaction.
570571
</para>
571572
</listitem>
572573
</varlistentry>

‎doc/src/sgml/ref/create_table.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1520,7 +1520,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
15201520
</listitem>
15211521
</varlistentry>
15221522

1523-
<varlistentry id="reloption-autovacuum-vauum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor">
1523+
<varlistentry id="reloption-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor">
15241524
<term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>floating point</type>)
15251525
<indexterm>
15261526
<primary><varname>autovacuum_vacuum_scale_factor</varname> </primary>
@@ -1610,7 +1610,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
16101610
</listitem>
16111611
</varlistentry>
16121612

1613-
<varlistentry id="reloption-autovacuum-vauum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit">
1613+
<varlistentry id="reloption-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit">
16141614
<term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>)
16151615
<indexterm>
16161616
<primary><varname>autovacuum_vacuum_cost_limit</varname></primary>

‎doc/src/sgml/ref/createuser.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ PostgreSQL documentation
4444
If you wish to create a new superuser, you must connect as a
4545
superuser, not merely with <literal>CREATEROLE</literal> privilege.
4646
Being a superuser implies the ability to bypass all access permission
47-
checks within the database, so superuserdom should not be granted lightly.
47+
checks within the database, so superuser access should not be granted lightly.
4848
</para>
4949

5050
<para>

0 commit comments

Comments
 (0)