diff options
author | Michael Paquier <michael@paquier.xyz> | 2021-04-09 13:53:07 +0900 |
---|---|---|
committer | Michael Paquier <michael@paquier.xyz> | 2021-04-09 13:53:07 +0900 |
commit | 609b0652af00374b89411ea2613fd5bb92bca92c (patch) | |
tree | f21a820ed35b1ce3c67f2a9da1b5618f805ecea2 /doc/src | |
parent | 796092fb84c08162ae803e83a13aa8bd6d9b23d0 (diff) | |
download | postgresql-609b0652af00374b89411ea2613fd5bb92bca92c.tar.gz postgresql-609b0652af00374b89411ea2613fd5bb92bca92c.zip |
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/20210408164008.GJ6592@telsasoft.com
Backpatch-through: 9.6
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/config.sgml | 10 | ||||
-rw-r--r-- | doc/src/sgml/func.sgml | 16 | ||||
-rw-r--r-- | doc/src/sgml/logical-replication.sgml | 11 | ||||
-rw-r--r-- | doc/src/sgml/maintenance.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/monitoring.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/perform.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/pgstatstatements.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/postgres-fdw.sgml | 9 | ||||
-rw-r--r-- | doc/src/sgml/ref/create_table.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/createuser.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/ref/declare.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_amcheck.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/ref/psql-ref.sgml | 7 | ||||
-rw-r--r-- | doc/src/sgml/wal.sgml | 2 |
14 files changed, 38 insertions, 37 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 26628f3e6d3..3a062a145ca 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -2723,7 +2723,7 @@ include_dir 'conf.d' Note that changing <varname>wal_level</varname> to <literal>minimal</literal> makes any base backups taken before unavailable for archive recovery and standby server, which may - lead to database loss. + lead to data loss. </para> <para> In <literal>logical</literal> level, the same information is logged as @@ -3098,7 +3098,7 @@ include_dir 'conf.d' <listitem> <para> When this parameter is <literal>on</literal>, the <productname>PostgreSQL</productname> - server compresses a full page image written to WAL when + server compresses full page images written to WAL when <xref linkend="guc-full-page-writes"/> is on or during a base backup. A compressed page image will be decompressed during WAL replay. The default value is <literal>off</literal>. @@ -4137,7 +4137,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows On the subscriber side, specifies how many replication origins (see <xref linkend="replication-origins"/>) can be tracked simultaneously, effectively limiting how many logical replication subscriptions can - be created on the server. Setting it a lower value than the current + be created on the server. Setting it to a lower value than the current number of tracked replication origins (reflected in <link linkend="view-pg-replication-origin-status">pg_replication_origin_status</link>, 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; The <xref linkend="pgstatstatements"/> extension also requires a query identifier to be computed. Note that an external module can alternatively be used if the in-core query identifier computation - specification isn't acceptable. In this case, in-core computation + method is not acceptable. In this case, in-core computation must be disabled. The default is <literal>off</literal>. </para> <note> <para> - To ensure that a only one query identifier is calculated and + To ensure that only one query identifier is calculated and displayed, extensions that calculate query identifiers should throw an error if a query identifier has already been computed. </para> diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 0606b6a9aa4..67d802b02c2 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -3560,7 +3560,7 @@ repeat('Pg', 4) <returnvalue>PgPgPgPg</returnvalue> <returnvalue>text</returnvalue> </para> <para> - Evaluate escaped Unicode characters in argument. Unicode characters + Evaluate escaped Unicode characters in the argument. Unicode characters can be specified as <literal>\<replaceable>XXXX</replaceable></literal> (4 hexadecimal digits), <literal>\+<replaceable>XXXXXX</replaceable></literal> (6 @@ -24926,12 +24926,12 @@ SELECT collation for ('foo' COLLATE "de_DE"); <returnvalue>boolean</returnvalue> </para> <para> - Requests to log the memory contexts whose backend process has - the specified process ID. These memory contexts will be logged at + Requests to log the memory contexts of the backend with the + specified process ID. These memory contexts will be logged at <literal>LOG</literal> message level. They will appear in the server log based on the log configuration set (See <xref linkend="runtime-config-logging"/> for more information), - but will not be sent to the client whatever the setting of + but will not be sent to the client regardless of <xref linkend="guc-client-min-messages"/>. Only superusers can request to log the memory contexts. </para></entry> @@ -25037,7 +25037,7 @@ SELECT collation for ('foo' COLLATE "de_DE"); <para> <function>pg_log_backend_memory_contexts</function> can be used - to log the memory contexts of the backend process. For example, + to log the memory contexts of a backend process. For example: <programlisting> postgres=# SELECT pg_log_backend_memory_contexts(pg_backend_pid()); pg_log_backend_memory_contexts @@ -25061,8 +25061,8 @@ LOG: level: 1; TransactionAbortContext: 32768 total in 1 blocks; 32504 free (0 LOG: level: 1; ErrorContext: 8192 total in 1 blocks; 7928 free (3 chunks); 264 used LOG: Grand total: 1651920 bytes in 201 blocks; 622360 free (88 chunks); 1029560 used </screen> - For more than 100 child contexts under the same parent one, - 100 child contexts and a summary of the remaining ones will be logged. + If there are more than 100 child contexts under the same parent, the first + 100 child contexts are logged, along with a summary of the remaining contexts. Note that frequent calls to this function could incur significant overhead, because it may generate a large number of log messages. </para> @@ -25576,7 +25576,7 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup()); Returns recovery pause state. The return values are <literal> not paused</literal> if pause is not requested, <literal> pause requested</literal> if pause is requested but recovery is - not yet paused and, <literal>paused</literal> if the recovery is + not yet paused, and <literal>paused</literal> if the recovery is actually paused. </para></entry> </row> diff --git a/doc/src/sgml/logical-replication.sgml b/doc/src/sgml/logical-replication.sgml index e95d446dacb..73789526518 100644 --- a/doc/src/sgml/logical-replication.sgml +++ b/doc/src/sgml/logical-replication.sgml @@ -490,9 +490,9 @@ any changes that happened during the initial data copy using standard logical replication. During this synchronization phase, the changes are applied and committed in the same order as they happened on the - publisher. Once the synchronization is done, the control of the + publisher. Once synchronization is done, control of the replication of the table is given back to the main apply process where - the replication continues as normal. + replication continues as normal. </para> </sect2> </sect1> @@ -602,10 +602,9 @@ </para> <para> - The subscriber also requires the <varname>max_replication_slots</varname> - be set to configure how many replication origins can be tracked. In this - case it should be set to at least the number of subscriptions that will be - added to the subscriber, plus some reserve for table synchronization. + <varname>max_replication_slots</varname> must also be set on the subscriber. + It should be set to at least the number of subscriptions that will be added + to the subscriber, plus some reserve for table synchronization. <varname>max_logical_replication_workers</varname> must be set to at least the number of subscriptions, again plus some reserve for the table synchronization. Additionally the <varname>max_worker_processes</varname> diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml index 3bbae6dd917..4adb34a21b1 100644 --- a/doc/src/sgml/maintenance.sgml +++ b/doc/src/sgml/maintenance.sgml @@ -185,7 +185,7 @@ never issue <command>VACUUM FULL</command>. In this approach, the idea is not to keep tables at their minimum size, but to maintain steady-state usage of disk space: each table occupies space equivalent to its - minimum size plus however much space gets used up between vacuumings. + minimum size plus however much space gets used up between vacuum runs. Although <command>VACUUM FULL</command> can be used to shrink a table back to its minimum size and return the disk space to the operating system, there is not much point in this if the table will just grow again in the diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index f637fe04152..8287587f614 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -5890,7 +5890,7 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid, </para> <para> When creating an index on a partitioned table, this column is set to - the number of partitions on which the index has been completed. + the number of partitions on which the index has been created. This field is <literal>0</literal> during a <literal>REINDEX</literal>. </para></entry> </row> diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml index e0d3f246e9a..89ff58338e5 100644 --- a/doc/src/sgml/perform.sgml +++ b/doc/src/sgml/perform.sgml @@ -1747,7 +1747,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse; <xref linkend="guc-max-wal-senders"/> to zero. But note that changing these settings requires a server restart, and makes any base backups taken before unavailable for archive - recovery and standby server, which may lead to database loss. + recovery and standby server, which may lead to data loss. </para> <para> @@ -1899,7 +1899,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse; much faster. The following are configuration changes you can make to improve performance in such cases. Except as noted below, durability is still guaranteed in case of a crash of the database software; - only abrupt operating system stoppage creates a risk of data loss + only an abrupt operating system crash creates a risk of data loss or corruption when these settings are used. <itemizedlist> diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index 5ad4f0aed2a..e235504e9a9 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -406,7 +406,7 @@ <note> <para> The following details about constant replacement and - <structfield>queryid</structfield> only applies when <xref + <structfield>queryid</structfield> only apply when <xref linkend="guc-compute-query-id"/> is enabled. If you use an external module instead to compute <structfield>queryid</structfield>, you should refer to its documentation for details. diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml index fd349569369..5320accf6f4 100644 --- a/doc/src/sgml/postgres-fdw.sgml +++ b/doc/src/sgml/postgres-fdw.sgml @@ -551,8 +551,9 @@ OPTIONS (ADD password_required 'false'); <title>Connection Management Options</title> <para> - By default all the open connections that <filename>postgres_fdw</filename> - established to the foreign servers are kept in local session for re-use. + By default, all connections that <filename>postgres_fdw</filename> + establishes to foreign servers are kept open in the local session + for re-use. </para> <variablelist> @@ -562,11 +563,11 @@ OPTIONS (ADD password_required 'false'); <listitem> <para> This option controls whether <filename>postgres_fdw</filename> keeps - the connections to the foreign server open so that the subsequent + the connections to the foreign server open so that subsequent queries can re-use them. It can only be specified for a foreign server. The default is <literal>on</literal>. If set to <literal>off</literal>, all connections to this foreign server will be discarded at the end of - transaction. + each transaction. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 44e50620fd1..d7fffddbce3 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1520,7 +1520,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> - <varlistentry id="reloption-autovacuum-vauum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> + <varlistentry id="reloption-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>floating point</type>) <indexterm> <primary><varname>autovacuum_vacuum_scale_factor</varname> </primary> @@ -1610,7 +1610,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> - <varlistentry id="reloption-autovacuum-vauum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> + <varlistentry id="reloption-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>) <indexterm> <primary><varname>autovacuum_vacuum_cost_limit</varname></primary> diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index 4d60dc2cda1..17579e50afb 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -44,7 +44,7 @@ PostgreSQL documentation If you wish to create a new superuser, you must connect as a superuser, not merely with <literal>CREATEROLE</literal> privilege. Being a superuser implies the ability to bypass all access permission - checks within the database, so superuserdom should not be granted lightly. + checks within the database, so superuser access should not be granted lightly. </para> <para> diff --git a/doc/src/sgml/ref/declare.sgml b/doc/src/sgml/ref/declare.sgml index 8a2b8cc8929..aa3d1d1fa16 100644 --- a/doc/src/sgml/ref/declare.sgml +++ b/doc/src/sgml/ref/declare.sgml @@ -335,7 +335,7 @@ DECLARE liahona CURSOR FOR SELECT * FROM films; <para> According to the SQL standard, changes made to insensitive cursors by <literal>UPDATE ... WHERE CURRENT OF</literal> and <literal>DELETE - ... WHERE CURRENT OF</literal> statements are visibible in that same + ... WHERE CURRENT OF</literal> statements are visible in that same cursor. <productname>PostgreSQL</productname> treats these statements like all other data changing statements in that they are not visible in insensitive cursors. diff --git a/doc/src/sgml/ref/pg_amcheck.sgml b/doc/src/sgml/ref/pg_amcheck.sgml index fcc96b430a6..d01e26faa81 100644 --- a/doc/src/sgml/ref/pg_amcheck.sgml +++ b/doc/src/sgml/ref/pg_amcheck.sgml @@ -460,7 +460,7 @@ PostgreSQL documentation <term><option>--skip=<replaceable class="parameter">option</replaceable></option></term> <listitem> <para> - If <literal>"all-frozen"</literal> is given, table corruption checks + If <literal>all-frozen</literal> is given, table corruption checks will skip over pages in all tables that are marked as all frozen. </para> <para> diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index ddb70433625..a3cfd3b5575 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1927,9 +1927,10 @@ testdb=> </para> <para> - The column of the kind of extended stats (e.g. Ndistinct) shows its status. - NULL means that it doesn't exists. "defined" means that it was requested - when creating the statistics. + The status of each kind of extended statistics is shown in a column + named after its statistic kind (e.g. Ndistinct). + "defined" means that it was requested when creating the statistics, + and NULL means it wasn't requested. You can use pg_stats_ext if you'd like to know whether <link linkend="sql-analyze"> <command>ANALYZE</command></link> was run and statistics are available to the planner. diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index 0f13c43095e..24cf567ee2e 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -797,7 +797,7 @@ <literal>fsync</literal>, or <literal>fsync_writethrough</literal>, the write operation moves WAL buffers to kernel cache and <function>issue_xlog_fsync</function> syncs them to disk. Regardless - of the setting of <varname>track_wal_io_timing</varname>, the numbers + of the setting of <varname>track_wal_io_timing</varname>, the number of times <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are also counted as <literal>wal_write</literal> and <literal>wal_sync</literal> |