1
0
mirror of https://github.com/postgres/postgres.git synced 2025-11-22 12:22:45 +03:00

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
This commit is contained in:
Daniel Gustafsson
2025-11-20 15:04:41 +01:00
parent 20bff3d794
commit fa0ffa2877
10 changed files with 20 additions and 20 deletions

View File

@@ -1234,7 +1234,7 @@ include_dir 'conf.d'
</term> </term>
<listitem> <listitem>
<para> <para>
The library/libraries to use for validating OAuth connection tokens. If Sets the library/libraries to use for validating OAuth connection tokens. If
only one validator library is provided, it will be used by default for only one validator library is provided, it will be used by default for
any OAuth connections; otherwise, all any OAuth connections; otherwise, all
<link linkend="auth-oauth"><literal>oauth</literal> HBA entries</link> <link linkend="auth-oauth"><literal>oauth</literal> HBA entries</link>
@@ -1400,7 +1400,7 @@ include_dir 'conf.d'
<para> <para>
Specifies a list of cipher suites that are allowed by connections using Specifies a list of cipher suites that are allowed by connections using
<acronym>TLS</acronym> version 1.3. Multiple cipher suites can be <acronym>TLS</acronym> version 1.3. Multiple cipher suites can be
specified by using a colon separated list. If left blank, the default specified by using a colon-separated list. If left blank, the default
set of cipher suites in <productname>OpenSSL</productname> will be used. set of cipher suites in <productname>OpenSSL</productname> will be used.
</para> </para>
@@ -2436,8 +2436,8 @@ include_dir 'conf.d'
</term> </term>
<listitem> <listitem>
<para> <para>
Sets the maximum number of open files each server subprocess is Sets the maximum number of files each server subprocess is
allowed to open simultaneously; files already opened in the allowed to have open simultaneously; files already opened in the
postmaster are not counted toward this limit. The default is one postmaster are not counted toward this limit. The default is one
thousand files. thousand files.
</para> </para>

View File

@@ -3170,7 +3170,7 @@ ninja install
<para> <para>
Enable additional test suites, which are not run by default because Enable additional test suites, which are not run by default because
they are not secure to run on a multiuser system, require special they are not secure to run on a multiuser system, require special
software to run, or are resource intensive. The argument is a software to run, or are resource-intensive. The argument is a
whitespace-separated list of tests to enable. See whitespace-separated list of tests to enable. See
<xref linkend="regress-additional"/> for details. If the <xref linkend="regress-additional"/> for details. If the
<envar>PG_TEST_EXTRA</envar> environment variable is set when the <envar>PG_TEST_EXTRA</envar> environment variable is set when the

View File

@@ -1226,7 +1226,7 @@ postgres=# SELECT postgres_fdw_disconnect_all();
<term><literal>PostgresFdwCleanupResult</literal></term> <term><literal>PostgresFdwCleanupResult</literal></term>
<listitem> <listitem>
<para> <para>
Waiting for transaction abort on remote server. Waiting for transaction abort on a remote server.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

View File

@@ -49,7 +49,7 @@ break is not needed in a wider output rendering.
</para> </para>
<para> <para>
After you have successfully completed this tutorial you will want to After you have successfully completed this tutorial, you will want to
read the <xref linkend="sql"/> section to gain a better understanding read the <xref linkend="sql"/> section to gain a better understanding
of the SQL language, or <xref linkend="client-interfaces"/> for of the SQL language, or <xref linkend="client-interfaces"/> for
information about developing applications with information about developing applications with

View File

@@ -1636,7 +1636,7 @@ SELCT 1/0;<!-- this typo is intentional -->
<para> <para>
Likewise the server expects the client to not begin Likewise the server expects the client to not begin
the <acronym>SSL</acronym> negotiation until it receives the server's the <acronym>SSL</acronym> negotiation until it receives the server's
single byte response to the <acronym>SSL</acronym> request. If the single-byte response to the <acronym>SSL</acronym> request. If the
client begins the <acronym>SSL</acronym> negotiation immediately without client begins the <acronym>SSL</acronym> negotiation immediately without
waiting for the server response to be received it can reduce connection waiting for the server response to be received it can reduce connection
latency by one round-trip. However this comes at the cost of not being latency by one round-trip. However this comes at the cost of not being

View File

@@ -84,7 +84,7 @@ PostgreSQL documentation
</para> </para>
<para> <para>
The <option>--slot</option> and <option>--dbname</option> are required The <option>--slot</option> and <option>--dbname</option> options are required
for this action. for this action.
</para> </para>
@@ -104,7 +104,7 @@ PostgreSQL documentation
</para> </para>
<para> <para>
The <option>--slot</option> is required for this action. The <option>--slot</option> option is required for this action.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -121,8 +121,8 @@ PostgreSQL documentation
</para> </para>
<para> <para>
The <option>--slot</option> and <option>--dbname</option>, The <option>--slot</option>, <option>--dbname</option>, and
<option>--file</option> are required for this action. <option>--file</option> options are required for this action.
</para> </para>
<para> <para>

View File

@@ -2858,7 +2858,7 @@ statement latencies in milliseconds, failures and retries:
start a connection to the database server / the socket for connecting start a connection to the database server / the socket for connecting
the client to the database server has become invalid). In such cases the client to the database server has become invalid). In such cases
all clients of this thread stop while other threads continue to work. all clients of this thread stop while other threads continue to work.
However, <option>--exit-on-abort</option> is specified, all of the However, if <option>--exit-on-abort</option> is specified, all of the
threads stop immediately in this case. threads stop immediately in this case.
</para> </para>
</listitem> </listitem>

View File

@@ -266,7 +266,7 @@ make check-world -j8 >/dev/null
<para> <para>
Some test suites are not run by default, either because they are not secure Some test suites are not run by default, either because they are not secure
to run on a multiuser system, because they require special software or to run on a multiuser system, because they require special software or
because they are resource intensive. You can decide which test suites to because they are resource-intensive. You can decide which test suites to
run additionally by setting the <command>make</command> or environment run additionally by setting the <command>make</command> or environment
variable <varname>PG_TEST_EXTRA</varname> to a whitespace-separated list, variable <varname>PG_TEST_EXTRA</varname> to a whitespace-separated list,
for example: for example:
@@ -337,7 +337,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
<filename>src/bin/pg_upgrade/t/002_pg_upgrade.pl</filename> which <filename>src/bin/pg_upgrade/t/002_pg_upgrade.pl</filename> which
cycles the regression database through <command>pg_dump</command>/ cycles the regression database through <command>pg_dump</command>/
<command>pg_restore</command>. Not enabled by default because it <command>pg_restore</command>. Not enabled by default because it
is resource intensive. is resource-intensive.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -368,7 +368,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
<para> <para>
Uses <literal>wal_consistency_checking=all</literal> while running Uses <literal>wal_consistency_checking=all</literal> while running
certain tests under <filename>src/test/recovery</filename>. Not certain tests under <filename>src/test/recovery</filename>. Not
enabled by default because it is resource intensive. enabled by default because it is resource-intensive.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -378,7 +378,7 @@ make check-world PG_TEST_EXTRA='kerberos ldap ssl load_balance libpq_encryption'
<listitem> <listitem>
<para> <para>
Runs the test suite under <filename>src/test/modules/xid_wraparound</filename>. Runs the test suite under <filename>src/test/modules/xid_wraparound</filename>.
Not enabled by default because it is resource intensive. Not enabled by default because it is resource-intensive.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

View File

@@ -53,7 +53,7 @@
<tbody> <tbody>
<row> <row>
<entry><link linkend="view-pg-aios"><structname>pg_aios</structname></link></entry> <entry><link linkend="view-pg-aios"><structname>pg_aios</structname></link></entry>
<entry>In-use asynchronous IO handles</entry> <entry>in-use asynchronous IO handles</entry>
</row> </row>
<row> <row>

View File

@@ -2399,7 +2399,7 @@ PG_FUNCTION_INFO_V1(funcname);
To call another version-1 function, you can use To call another version-1 function, you can use
<function>DirectFunctionCall<replaceable>n</replaceable>(func, <function>DirectFunctionCall<replaceable>n</replaceable>(func,
arg1, ..., argn)</function>. This is particularly useful when you want arg1, ..., argn)</function>. This is particularly useful when you want
to call functions defined in the standard internal library, by using an to call functions defined in the standard internal function library by using an
interface similar to their SQL signature. interface similar to their SQL signature.
</para> </para>
@@ -3940,7 +3940,7 @@ extern bool InjectionPointDetach(const char *name);
</para> </para>
<para> <para>
Enabling injections points requires Enabling injection points requires
<option>--enable-injection-points</option> with <option>--enable-injection-points</option> with
<command>configure</command> or <option>-Dinjection_points=true</option> <command>configure</command> or <option>-Dinjection_points=true</option>
with <application>Meson</application>. with <application>Meson</application>.