From 90fbf7c57df601c7e0b43ae7cf71f0f69908a7cc Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Thu, 24 Dec 2020 17:05:49 +0900 Subject: Fix typos and grammar in docs and comments This fixes several areas of the documentation and some comments in matters of style, grammar, or even format. Author: Justin Pryzby Discussion: https://postgr.es/m/20201222041153.GK30237@telsasoft.com --- doc/src/sgml/amcheck.sgml | 2 +- doc/src/sgml/catalogs.sgml | 2 +- doc/src/sgml/cube.sgml | 2 +- doc/src/sgml/func.sgml | 8 ++++---- doc/src/sgml/logicaldecoding.sgml | 8 ++++---- doc/src/sgml/monitoring.sgml | 4 ++-- doc/src/sgml/pgstatstatements.sgml | 2 +- doc/src/sgml/rangetypes.sgml | 2 +- doc/src/sgml/ref/create_type.sgml | 8 ++++---- doc/src/sgml/ref/explain.sgml | 6 +++--- doc/src/sgml/ref/pg_dump.sgml | 2 +- doc/src/sgml/ref/pg_verifybackup.sgml | 2 +- doc/src/sgml/ref/prepare.sgml | 2 +- doc/src/sgml/sources.sgml | 2 +- doc/src/sgml/wal.sgml | 2 +- 15 files changed, 27 insertions(+), 27 deletions(-) (limited to 'doc/src') diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml index 99fad708bf7..8dfb01a77be 100644 --- a/doc/src/sgml/amcheck.sgml +++ b/doc/src/sgml/amcheck.sgml @@ -525,7 +525,7 @@ SET client_min_messages = DEBUG1; designed to diagnose corruption without undue risk. It cannot guard against all causes of backend crashes, as even executing the calling query could be unsafe on a badly corrupted system. Access to catalog tables are performed and could + linkend="catalogs-overview">catalog tables is performed and could be problematic if the catalogs themselves are corrupted. diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index d9886360467..3a2266526c4 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -4478,7 +4478,7 @@ SCRAM-SHA-256$<iteration count>:&l inherited columns are to be arranged. The count starts at 1. - Indexes can not have multiple inheritance, since they can only inherit + Indexes cannot have multiple inheritance, since they can only inherit when using declarative partitioning. diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index 3b39147d14d..3dd89bb14d7 100644 --- a/doc/src/sgml/cube.sgml +++ b/doc/src/sgml/cube.sgml @@ -321,7 +321,7 @@ SELECT c FROM test ORDER BY c ~> 3 DESC LIMIT 5; Makes a one dimensional cube. - cube(1,2) + cube(1, 2) (1),(2) diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 2707e757ca0..93d17e4b558 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1274,7 +1274,7 @@ repeat('Pg', 4) PgPgPgPg (truncates towards zero) - div(9,4) + div(9, 4) 2 @@ -1493,7 +1493,7 @@ repeat('Pg', 4) PgPgPgPg bigint, and numeric - mod(9,4) + mod(9, 4) 1 @@ -1975,7 +1975,7 @@ repeat('Pg', 4) PgPgPgPg result in radians - atan2(1,0) + atan2(1, 0) 1.5707963267948966 @@ -1995,7 +1995,7 @@ repeat('Pg', 4) PgPgPgPg result in degrees - atan2d(1,0) + atan2d(1, 0) 90 diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml index 813a037face..ca78a81e9c5 100644 --- a/doc/src/sgml/logicaldecoding.sgml +++ b/doc/src/sgml/logicaldecoding.sgml @@ -953,11 +953,11 @@ stream_commit_cb(...); <-- commit of the streamed transaction Similar to spill-to-disk behavior, streaming is triggered when the total amount of changes decoded from the WAL (for all in-progress transactions) - exceeds limit defined by logical_decoding_work_mem setting. - At that point the largest toplevel transaction (measured by amount of memory + exceeds the limit defined by logical_decoding_work_mem setting. + At that point, the largest toplevel transaction (measured by the amount of memory currently used for decoded changes) is selected and streamed. However, in - some cases we still have to spill to the disk even if streaming is enabled - because if we cross the memory limit but we still have not decoded the + some cases we still have to spill to disk even if streaming is enabled + because we exceed the memory threshold but still have not decoded the complete tuple e.g., only decoded toast table insert but not the main table insert. diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 52a69a53660..3d6c9013067 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -3470,7 +3470,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i wal_bytes numeric - Total amount of WAL bytes generated + Total amount of WAL generated in bytes @@ -3479,7 +3479,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i wal_buffers_full bigint - Number of times WAL data was written to the disk because WAL buffers got full + Number of times WAL data was written to disk because WAL buffers became full diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index 126ee31d9fd..464bf0e5aed 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -360,7 +360,7 @@ wal_bytes numeric - Total amount of WAL bytes generated by the statement + Total amount of WAL generated by the statement in bytes diff --git a/doc/src/sgml/rangetypes.sgml b/doc/src/sgml/rangetypes.sgml index 83aa9bc4e9e..859079c69ca 100644 --- a/doc/src/sgml/rangetypes.sgml +++ b/doc/src/sgml/rangetypes.sgml @@ -29,7 +29,7 @@ Every range type has a corresponding multirange type. A multirange is - an ordered list of non-continguous, non-empty, non-null ranges. Most + an ordered list of non-contiguous, non-empty, non-null ranges. Most range operators also work on multiranges, and they have a few functions of their own. diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index 7d2d6aa0af8..0b24a55505a 100644 --- a/doc/src/sgml/ref/create_type.sgml +++ b/doc/src/sgml/ref/create_type.sgml @@ -180,10 +180,10 @@ CREATE TYPE name The optional multirange_type_name parameter specifies the name of the corresponding multirange type. If not specified, this name is chosen automatically as follows. - If range type name contains range substring, then - multirange type name is formed by replacement of the range - substring with multirange substring in the range - type name. Otherwise, multirange type name is formed by appending + If the range type name contains the substring range, then + the multirange type name is formed by replacement of the range + substring with multirange in the range + type name. Otherwise, the multirange type name is formed by appending a _multirange suffix to the range type name. diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index b0ccdd26e73..c4512332a06 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -198,9 +198,9 @@ ROLLBACK; Include information on WAL record generation. Specifically, include the - number of records, number of full page images (fpi) and amount of WAL - bytes generated. In text format, only non-zero values are printed. This - parameter may only be used when ANALYZE is also + number of records, number of full page images (fpi) and the amount of WAL + generated in bytes. In text format, only non-zero values are printed. + This parameter may only be used when ANALYZE is also enabled. It defaults to FALSE. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 0aa35cf0c3b..dcb25dc3cd4 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -621,7 +621,7 @@ PostgreSQL documentation Specify the compression level to use. Zero means no compression. - For the custom archive format, this specifies compression of + For the custom and directory archive formats, this specifies compression of individual table-data segments, and the default is to compress at a moderate level. For plain text output, setting a nonzero compression level causes diff --git a/doc/src/sgml/ref/pg_verifybackup.sgml b/doc/src/sgml/ref/pg_verifybackup.sgml index a0989d3cd16..5f83c987063 100644 --- a/doc/src/sgml/ref/pg_verifybackup.sgml +++ b/doc/src/sgml/ref/pg_verifybackup.sgml @@ -40,7 +40,7 @@ PostgreSQL documentation It is important to note that the validation which is performed by - pg_verifybackup does not and can not include + pg_verifybackup does not and cannot include every check which will be performed by a running server when attempting to make use of the backup. Even if you use this tool, you should still perform test restores and verify that the resulting databases work as diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml index 22ce28e517c..aae91946c75 100644 --- a/doc/src/sgml/ref/prepare.sgml +++ b/doc/src/sgml/ref/prepare.sgml @@ -184,7 +184,7 @@ EXPLAIN EXECUTE name(parameter_valuesPostgreSQL will force re-analysis and re-planning of the statement before using it whenever database objects used in the statement have undergone - definitional (DDL) changes or the planner statistics of them have + definitional (DDL) changes or their planner statistics have been updated since the previous use of the prepared statement. Also, if the value of changes from one use to the next, the statement will be re-parsed using the new diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index 38a516080c1..62cf2fded40 100644 --- a/doc/src/sgml/sources.sgml +++ b/doc/src/sgml/sources.sgml @@ -103,7 +103,7 @@ less -x4 message text. In addition there are optional elements, the most common of which is an error identifier code that follows the SQL spec's SQLSTATE conventions. - ereport itself is just a shell macro, that exists + ereport itself is just a shell macro that exists mainly for the syntactic convenience of making message generation look like a single function call in the C source code. The only parameter accepted directly by ereport is the severity level. diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index d1c3893b147..f4bc147b106 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -580,7 +580,7 @@ Independently of max_wal_size, the most recent megabytes of WAL files plus one additional WAL file are - kept at all times. Also, if WAL archiving is used, old segments can not be + kept at all times. Also, if WAL archiving is used, old segments cannot be removed or recycled until they are archived. If WAL archiving cannot keep up with the pace that WAL is generated, or if archive_command fails repeatedly, old WAL files will accumulate in pg_wal -- cgit v1.2.3