From 5253906fac5a2f3669f7867bcb5507f6f0ea891c Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Tue, 29 Dec 2020 18:18:59 +0900 Subject: [PATCH] doc: Improve some grammar and sentences 90fbf7c has taken care of that for HEAD. This includes the portion of the fixes that applies to the documentation, where needed depending on the branch. Author: Justin Pryzby Discussion: https://postgr.es/m/20201227202604.GC26311@telsasoft.com Backpatch-through: 9.5 --- doc/src/sgml/catalogs.sgml | 2 +- doc/src/sgml/pgstatstatements.sgml | 2 +- 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/sources.sgml | 2 +- doc/src/sgml/wal.sgml | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 70536ce5c7..db45c0b993 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -4466,7 +4466,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/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index cf2d25b7b2..c7f7feaaf8 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -358,7 +358,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/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 906b2ccd50..cc4d1a8739 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 2ab7f39c3d..8ff5b7417f 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -630,7 +630,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 d454b970a1..23a0ba025c 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/sources.sgml b/doc/src/sgml/sources.sgml index 38a516080c..62cf2fded4 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 3c00d6db0d..7a2e111bfc 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