summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2023-04-12 13:03:09 +0900
committerMichael Paquier <michael@paquier.xyz>2023-04-12 13:03:09 +0900
commit644b848f50ef75430c0134654f86e8234691e390 (patch)
tree8e55dde3fbefb45076e5bc0f5040a6bb0114a3a8 /doc
parenta923e21631a29dc8b8781d7d02b5003d0df64ca3 (diff)
downloadpostgresql-644b848f50ef75430c0134654f86e8234691e390.tar.gz
doc: Fix some typos and grammar
This is a first batch of the fixes, for the most obvious fixes. A little bit more is under discussion. Author: Thom Brown, Justin Pryzby Discussion: https://postgr.es/m/CAA-aLv7xCZ0nBJa-NWe0rxBB28TjFjS2JtjiZMoQ+0wsugG+hQ@mail.gmail.com
Diffstat (limited to 'doc')
-rw-r--r--doc/src/sgml/archive-modules.sgml6
-rw-r--r--doc/src/sgml/client-auth.sgml6
-rw-r--r--doc/src/sgml/indexam.sgml2
-rw-r--r--doc/src/sgml/install-windows.sgml2
-rw-r--r--doc/src/sgml/logicaldecoding.sgml2
-rw-r--r--doc/src/sgml/pgbuffercache.sgml2
-rw-r--r--doc/src/sgml/postgres-fdw.sgml6
-rw-r--r--doc/src/sgml/ref/create_publication.sgml2
-rw-r--r--doc/src/sgml/ref/createuser.sgml4
-rw-r--r--doc/src/sgml/ref/pg_waldump.sgml2
-rw-r--r--doc/src/sgml/ref/psql-ref.sgml7
-rw-r--r--doc/src/sgml/ref/reindex.sgml2
12 files changed, 21 insertions, 22 deletions
diff --git a/doc/src/sgml/archive-modules.sgml b/doc/src/sgml/archive-modules.sgml
index 7cf44e82e2..7064307d9e 100644
--- a/doc/src/sgml/archive-modules.sgml
+++ b/doc/src/sgml/archive-modules.sgml
@@ -50,7 +50,7 @@
<function>_PG_archive_module_init</function>. The result of the function
must be a pointer to a struct of type
<structname>ArchiveModuleCallbacks</structname>, which contains everything
- that the core code needs to know how to make use of the archive module. The
+ that the core code needs to know to make use of the archive module. The
return value needs to be of server lifetime, which is typically achieved by
defining it as a <literal>static const</literal> variable in global scope.
@@ -82,7 +82,7 @@ typedef const ArchiveModuleCallbacks *(*ArchiveModuleInit) (void);
<para>
The <function>startup_cb</function> callback is called shortly after the
module is loaded. This callback can be used to perform any additional
- initialization required. If the archive module has a state, it can use
+ initialization required. If the archive module has any state, it can use
<structfield>state->private_data</structfield> to store it.
<programlisting>
@@ -143,7 +143,7 @@ typedef bool (*ArchiveFileCB) (ArchiveModuleState *state, const char *file, cons
process exits (e.g., after an error) or the value of
<xref linkend="guc-archive-library"/> changes. If no
<function>shutdown_cb</function> is defined, no special action is taken in
- these situations. If the archive module has a state, this callback should
+ these situations. If the archive module has any state, this callback should
free it to avoid leaks.
<programlisting>
diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml
index b9d73deced..dbba289600 100644
--- a/doc/src/sgml/client-auth.sgml
+++ b/doc/src/sgml/client-auth.sgml
@@ -104,10 +104,10 @@
Each record can be an include directive or an authentication record.
Include directives specify files that can be included, that contain
additional records. The records will be inserted in place of the
- include records. These records only contain two fields:
+ include directives. Include directives only contain two fields:
<literal>include</literal>, <literal>include_if_exists</literal> or
<literal>include_dir</literal> directive and the file or directory to be
- included. The file or directory can be a relative of absolute path, and can
+ included. The file or directory can be a relative or absolute path, and can
be double-quoted. For the <literal>include_dir</literal> form, all files
not starting with a <literal>.</literal> and ending with
<literal>.conf</literal> will be included. Multiple files within an include
@@ -810,7 +810,7 @@ host all all ::1/128 trust
host all all localhost trust
# The same using a regular expression for DATABASE, that allows connection
-# to the database db1, db2 and any databases with a name beginning by "db"
+# to the database db1, db2 and any databases with a name beginning with "db"
# and finishing with a number using two to four digits (like "db1234" or
# "db12").
#
diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml
index 29ece7c42e..e813e2b620 100644
--- a/doc/src/sgml/indexam.sgml
+++ b/doc/src/sgml/indexam.sgml
@@ -257,7 +257,7 @@ typedef struct IndexAmRoutine
Access methods that do not point to individual tuples, but to block ranges
(like <acronym>BRIN</acronym>), may allow the <acronym>HOT</acronym> optimization
to continue. This does not apply to attributes referenced in index
- predicates, an update of such attribute always disables <acronym>HOT</acronym>.
+ predicates, an update of such an attribute always disables <acronym>HOT</acronym>.
</para>
</sect1>
diff --git a/doc/src/sgml/install-windows.sgml b/doc/src/sgml/install-windows.sgml
index 2db44db2fd..cbc70a039c 100644
--- a/doc/src/sgml/install-windows.sgml
+++ b/doc/src/sgml/install-windows.sgml
@@ -550,7 +550,7 @@ $ENV{PROVE_TESTS}='t/020*.pl t/010*.pl'
<varlistentry>
<term><varname>OPENSSL</varname></term>
<listitem><para>
- Path to a <application>openssl</application> command. The default is
+ Path to an <application>openssl</application> command. The default is
<literal>openssl</literal>, which will search for a command by that
name in the configured <envar>PATH</envar>.
</para></listitem>
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index ebe0376e3e..e61059d71e 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -340,7 +340,7 @@ postgres=# select * from pg_logical_slot_get_changes('regression_slot', NULL, NU
primary. Thus, slot creation may need to wait for some activity to happen
on the primary. If the primary is idle, creating a logical slot on
standby may take noticeable time. This can be sped up by calling the
- <function>pg_log_standby_snapshot</function> on the primary.
+ <function>pg_log_standby_snapshot</function> function on the primary.
</para>
<caution>
diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 43c52e3829..27fdfc67a3 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -214,7 +214,7 @@
<structfield>buffers_used</structfield> <type>int4</type>
</para>
<para>
- Number of unused shared buffers
+ Number of used shared buffers
</para></entry>
</row>
diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index 9e66987cf7..a122794df3 100644
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -515,7 +515,7 @@ OPTIONS (ADD password_required 'false');
When multiple remote subtransactions are involved in the current local
subtransaction, by default <filename>postgres_fdw</filename> commits or
aborts those remote subtransactions serially when the local subtransaction
- is committed or abortd.
+ is committed or aborted.
Performance can be improved with the following options:
</para>
@@ -525,8 +525,8 @@ OPTIONS (ADD password_required 'false');
<term><literal>parallel_commit</literal> (<type>boolean</type>)</term>
<listitem>
<para>
- This option controls whether <filename>postgres_fdw</filename> commits
- in parallel remote transactions opened on a foreign server in a local
+ This option controls whether <filename>postgres_fdw</filename> commits,
+ in parallel, remote transactions opened on a foreign server in a local
transaction when the local transaction is committed. This setting also
applies to remote and local subtransactions. This option can only be
specified for foreign servers, not per-table. The default is
diff --git a/doc/src/sgml/ref/create_publication.sgml b/doc/src/sgml/ref/create_publication.sgml
index e3e1d04e73..606aa64ecf 100644
--- a/doc/src/sgml/ref/create_publication.sgml
+++ b/doc/src/sgml/ref/create_publication.sgml
@@ -205,7 +205,7 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
There can be a case where a subscription combines multiple
publications. If a partitioned table is published by any
subscribed publications which set
- <literal>publish_via_partition_root</literal> = true, changes on this
+ <literal>publish_via_partition_root = true</literal>, changes on this
partitioned table (or on its partitions) will be published using
the identity and schema of this partitioned table rather than
that of the individual partitions.
diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml
index 0e19da90d3..c5c74b86a2 100644
--- a/doc/src/sgml/ref/createuser.sgml
+++ b/doc/src/sgml/ref/createuser.sgml
@@ -85,7 +85,7 @@ PostgreSQL documentation
<term><option>--admin=<replaceable class="parameter">role</replaceable></option></term>
<listitem>
<para>
- Indicates role that will be immediately added as a member of the new
+ Indicates a role that will be immediately added as a member of the new
role with admin option, giving it the right to grant membership in the
new role to others. Multiple roles to add as members (with admin
option) of the new role can be specified by writing multiple
@@ -153,7 +153,7 @@ PostgreSQL documentation
<term><option>--role=<replaceable class="parameter">role</replaceable></option></term>
<listitem>
<para>
- Indicates role to which this role will be added immediately as a new
+ Indicates a role to which this role will be added immediately as a new
member. Multiple roles to which this role will be added as a member
can be specified by writing multiple
<option>-g</option> switches.
diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml
index 7685d3d15b..300edc9fc4 100644
--- a/doc/src/sgml/ref/pg_waldump.sgml
+++ b/doc/src/sgml/ref/pg_waldump.sgml
@@ -295,7 +295,7 @@ PostgreSQL documentation
<row>
<entry>FORK</entry>
<entry>
- The name of the fork the full page image came from, as of
+ The name of the fork the full page image came from, such as
<literal>_main</literal>, <literal>_fsm</literal>,
<literal>_vm</literal>, or <literal>_init</literal>.
</entry>
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index f4f25d1b07..dc422373d6 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -2903,17 +2903,16 @@ lo_import 152801
<para>
<literal>full</literal>: the expanded header is not truncated,
- and will be as wide as the widest output
- line.
+ and will be as wide as the widest output line.
</para>
<para>
- <literal>column</literal>: truncate the header line at the
+ <literal>column</literal>: truncate the header line to the
width of the first column.
</para>
<para>
- <literal>page</literal>: truncate the header line at the terminal
+ <literal>page</literal>: truncate the header line to the terminal
width.
</para>
diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml
index c6ad2546f9..71455dfdc7 100644
--- a/doc/src/sgml/ref/reindex.sgml
+++ b/doc/src/sgml/ref/reindex.sgml
@@ -129,7 +129,7 @@ REINDEX [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] { DA
<para>
Recreate all indexes within the current database, except system
catalogs.
- Indexes on shared system catalogs are not processed.
+ Indexes on system catalogs are not processed.
This form of <command>REINDEX</command> cannot be executed inside a
transaction block.
</para>