Skip to content

Commit fa0ffa2

Browse files
doc: Assorted documentation improvements
A set of wording improvements and spelling fixes. Author: Oleg Sibiryakov <o.sibiryakov@postgrespro.ru> Reviewed-by: Daniel Gustafsson <daniel@yesql.se> Reviewed-by: Peter Eisentraut <peter@eisentraut.org> Discussion: https://postgr.es/m/e62bedb5-c26f-4d37-b4ed-ce9b55f1e980@postgrespro.ru
1 parent 20bff3d commit fa0ffa2

File tree

10 files changed

+20
-20
lines changed

10 files changed

+20
-20
lines changed

doc/src/sgml/config.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1234,7 +1234,7 @@ include_dir 'conf.d'
12341234
</term>
12351235
<listitem>
12361236
<para>
1237-
The library/libraries to use for validating OAuth connection tokens. If
1237+
Sets the library/libraries to use for validating OAuth connection tokens. If
12381238
only one validator library is provided, it will be used by default for
12391239
any OAuth connections; otherwise, all
12401240
<link linkend="auth-oauth"><literal>oauth</literal> HBA entries</link>
@@ -1400,7 +1400,7 @@ include_dir 'conf.d'
14001400
<para>
14011401
Specifies a list of cipher suites that are allowed by connections using
14021402
<acronym>TLS</acronym> version 1.3. Multiple cipher suites can be
1403-
specified by using a colon separated list. If left blank, the default
1403+
specified by using a colon-separated list. If left blank, the default
14041404
set of cipher suites in <productname>OpenSSL</productname> will be used.
14051405
</para>
14061406

@@ -2436,8 +2436,8 @@ include_dir 'conf.d'
24362436
</term>
24372437
<listitem>
24382438
<para>
2439-
Sets the maximum number of open files each server subprocess is
2440-
allowed to open simultaneously; files already opened in the
2439+
Sets the maximum number of files each server subprocess is
2440+
allowed to have open simultaneously; files already opened in the
24412441
postmaster are not counted toward this limit. The default is one
24422442
thousand files.
24432443
</para>

doc/src/sgml/installation.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3170,7 +3170,7 @@ ninja install
31703170
<para>
31713171
Enable additional test suites, which are not run by default because
31723172
they are not secure to run on a multiuser system, require special
3173-
software to run, or are resource intensive. The argument is a
3173+
software to run, or are resource-intensive. The argument is a
31743174
whitespace-separated list of tests to enable. See
31753175
<xref linkend="regress-additional"/> for details. If the
31763176
<envar>PG_TEST_EXTRA</envar> environment variable is set when the

doc/src/sgml/postgres-fdw.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1226,7 +1226,7 @@ postgres=# SELECT postgres_fdw_disconnect_all();
12261226
<term><literal>PostgresFdwCleanupResult</literal></term>
12271227
<listitem>
12281228
<para>
1229-
Waiting for transaction abort on remote server.
1229+
Waiting for transaction abort on a remote server.
12301230
</para>
12311231
</listitem>
12321232
</varlistentry>

doc/src/sgml/postgres.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ break is not needed in a wider output rendering.
4949
</para>
5050

5151
<para>
52-
After you have successfully completed this tutorial you will want to
52+
After you have successfully completed this tutorial, you will want to
5353
read the <xref linkend="sql"/> section to gain a better understanding
5454
of the SQL language, or <xref linkend="client-interfaces"/> for
5555
information about developing applications with

doc/src/sgml/protocol.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1636,7 +1636,7 @@ SELCT 1/0;<!-- this typo is intentional -->
16361636
<para>
16371637
Likewise the server expects the client to not begin
16381638
the <acronym>SSL</acronym> negotiation until it receives the server's
1639-
single byte response to the <acronym>SSL</acronym> request. If the
1639+
single-byte response to the <acronym>SSL</acronym> request. If the
16401640
client begins the <acronym>SSL</acronym> negotiation immediately without
16411641
waiting for the server response to be received it can reduce connection
16421642
latency by one round-trip. However this comes at the cost of not being

doc/src/sgml/ref/pg_recvlogical.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ PostgreSQL documentation
8484
</para>
8585

8686
<para>
87-
The <option>--slot</option> and <option>--dbname</option> are required
87+
The <option>--slot</option> and <option>--dbname</option> options are required
8888
for this action.
8989
</para>
9090

@@ -104,7 +104,7 @@ PostgreSQL documentation
104104
</para>
105105

106106
<para>
107-
The <option>--slot</option> is required for this action.
107+
The <option>--slot</option> option is required for this action.
108108
</para>
109109
</listitem>
110110
</varlistentry>
@@ -121,8 +121,8 @@ PostgreSQL documentation
121121
</para>
122122

123123
<para>
124-
The <option>--slot</option> and <option>--dbname</option>,
125-
<option>--file</option> are required for this action.
124+
The <option>--slot</option>, <option>--dbname</option>, and
125+
<option>--file</option> options are required for this action.
126126
</para>
127127

128128
<para>

doc/src/sgml/ref/pgbench.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2858,7 +2858,7 @@ statement latencies in milliseconds, failures and retries:
28582858
start a connection to the database server / the socket for connecting
28592859
the client to the database server has become invalid). In such cases
28602860
all clients of this thread stop while other threads continue to work.
2861-
However, <option>--exit-on-abort</option> is specified, all of the
2861+
However, if <option>--exit-on-abort</option> is specified, all of the
28622862
threads stop immediately in this case.
28632863
</para>
28642864
</listitem>

doc/src/sgml/regress.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ make check-world -j8 >/dev/null
266266
<para>
267267
Some test suites are not run by default, either because they are not secure
268268
to run on a multiuser system, because they require special software or
269-
because they are resource intensive. You can decide which test suites to
269+
because they are resource-intensive. You can decide which test suites to
270270
run additionally by setting the <command>make</command> or environment
271271
variable <varname>PG_TEST_EXTRA</varname> to a whitespace-separated list,
272272
for example:
@@ -337,7 +337,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
337337
<filename>src/bin/pg_upgrade/t/002_pg_upgrade.pl</filename> which
338338
cycles the regression database through <command>pg_dump</command>/
339339
<command>pg_restore</command>. Not enabled by default because it
340-
is resource intensive.
340+
is resource-intensive.
341341
</para>
342342
</listitem>
343343
</varlistentry>
@@ -368,7 +368,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
368368
<para>
369369
Uses <literal>wal_consistency_checking=all</literal> while running
370370
certain tests under <filename>src/test/recovery</filename>. Not
371-
enabled by default because it is resource intensive.
371+
enabled by default because it is resource-intensive.
372372
</para>
373373
</listitem>
374374
</varlistentry>
@@ -378,7 +378,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
378378
<listitem>
379379
<para>
380380
Runs the test suite under <filename>src/test/modules/xid_wraparound</filename>.
381-
Not enabled by default because it is resource intensive.
381+
Not enabled by default because it is resource-intensive.
382382
</para>
383383
</listitem>
384384
</varlistentry>

doc/src/sgml/system-views.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
<tbody>
5454
<row>
5555
<entry><link linkend="view-pg-aios"><structname>pg_aios</structname></link></entry>
56-
<entry>In-use asynchronous IO handles</entry>
56+
<entry>in-use asynchronous IO handles</entry>
5757
</row>
5858

5959
<row>

doc/src/sgml/xfunc.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2399,7 +2399,7 @@ PG_FUNCTION_INFO_V1(funcname);
23992399
To call another version-1 function, you can use
24002400
<function>DirectFunctionCall<replaceable>n</replaceable>(func,
24012401
arg1, ..., argn)</function>. This is particularly useful when you want
2402-
to call functions defined in the standard internal library, by using an
2402+
to call functions defined in the standard internal function library by using an
24032403
interface similar to their SQL signature.
24042404
</para>
24052405

@@ -3940,7 +3940,7 @@ extern bool InjectionPointDetach(const char *name);
39403940
</para>
39413941

39423942
<para>
3943-
Enabling injections points requires
3943+
Enabling injection points requires
39443944
<option>--enable-injection-points</option> with
39453945
<command>configure</command> or <option>-Dinjection_points=true</option>
39463946
with <application>Meson</application>.

0 commit comments

Comments
 (0)