doc: Fix format, incorrect structure names and markup inconsistencies

Author: Alexander Lakhin
Discussion: https://postgr.es/m/a2345841-10a5-4eef-257c-02302347cf39@gmail.com
Backpatch-through: 13
This commit is contained in:
Michael Paquier 2020-08-22 22:26:18 +09:00
parent 3669792934
commit 610394c7b8
5 changed files with 27 additions and 23 deletions

View File

@ -564,8 +564,8 @@
</indexterm> </indexterm>
<para> <para>
<acronym>PostgreSQL</acronym> can accept time zone specifications that <productname>PostgreSQL</productname> can accept time zone specifications
are written according to the <acronym>POSIX</acronym> standard's rules that are written according to the <acronym>POSIX</acronym> standard's rules
for the <varname>TZ</varname> environment for the <varname>TZ</varname> environment
variable. <acronym>POSIX</acronym> time zone specifications are variable. <acronym>POSIX</acronym> time zone specifications are
inadequate to deal with the complexity of real-world time zone history, inadequate to deal with the complexity of real-world time zone history,
@ -635,8 +635,8 @@
or <literal>-</literal>). The positive sign is used for or <literal>-</literal>). The positive sign is used for
zones <emphasis>west</emphasis> of Greenwich. (Note that this is the zones <emphasis>west</emphasis> of Greenwich. (Note that this is the
opposite of the ISO-8601 sign convention used elsewhere in opposite of the ISO-8601 sign convention used elsewhere in
<acronym>PostgreSQL</acronym>.) <replaceable>hh</replaceable> can have <productname>PostgreSQL</productname>.) <replaceable>hh</replaceable>
one or two digits; <replaceable>mm</replaceable> can have one or two digits; <replaceable>mm</replaceable>
and <replaceable>ss</replaceable> (if used) must have two. and <replaceable>ss</replaceable> (if used) must have two.
</para> </para>

View File

@ -14074,7 +14074,7 @@ SELECT xmltable.*
size_sq_km float PATH 'SIZE[@unit = "sq_km"]', size_sq_km float PATH 'SIZE[@unit = "sq_km"]',
size_other text PATH size_other text PATH
'concat(SIZE[@unit!="sq_km"], " ", SIZE[@unit!="sq_km"]/@unit)', 'concat(SIZE[@unit!="sq_km"], " ", SIZE[@unit!="sq_km"]/@unit)',
premier_name text PATH 'PREMIER_NAME' DEFAULT 'not specified') ; premier_name text PATH 'PREMIER_NAME' DEFAULT 'not specified');
id | ordinality | COUNTRY_NAME | country_id | size_sq_km | size_other | premier_name id | ordinality | COUNTRY_NAME | country_id | size_sq_km | size_other | premier_name
----+------------+--------------+------------+------------+--------------+--------------- ----+------------+--------------+------------+------------+--------------+---------------

View File

@ -781,7 +781,7 @@ PGPing PQping(const char *conninfo);
<listitem> <listitem>
<para> <para>
<function>PQsetSSLKeyPassHook_OpenSSL</function> lets an application override <function>PQsetSSLKeyPassHook_OpenSSL</function> lets an application override
<literal>libpq</literal>'s <link linkend="libpq-ssl-clientcert">default <application>libpq</application>'s <link linkend="libpq-ssl-clientcert">default
handling of encrypted client certificate key files</link> using handling of encrypted client certificate key files</link> using
<xref linkend="libpq-connect-sslpassword"/> or interactive prompting. <xref linkend="libpq-connect-sslpassword"/> or interactive prompting.
@ -793,20 +793,23 @@ void PQsetSSLKeyPassHook_OpenSSL(PQsslKeyPassHook_OpenSSL_type hook);
<programlisting> <programlisting>
int callback_fn(char *buf, int size, PGconn *conn); int callback_fn(char *buf, int size, PGconn *conn);
</programlisting> </programlisting>
which <literal>libpq</literal> will then call <emphasis>instead of</emphasis> which <application>libpq</application> will then call
its default <function>PQdefaultSSLKeyPassHook_OpenSSL</function> handler. The callback <emphasis>instead of</emphasis> its default
should determine the password for the key and copy it to result-buffer <function>PQdefaultSSLKeyPassHook_OpenSSL</function> handler. The
<literal>buf</literal> of size <literal>size</literal>. The string in <literal> callback should determine the password for the key and copy it to
buf</literal> must be null-terminated. The callback must return the length of result-buffer <parameter>buf</parameter> of size
the password stored in <literal>buf</literal> excluding the null terminator. <parameter>size</parameter>. The string in <parameter>buf</parameter>
On failure, the callback should set <literal>buf[0] = '\0'</literal> and return 0. must be null-terminated. The callback must return the length of the
See <function>PQdefaultSSLKeyPassHook_OpenSSL</function> in <literal>libpq</literal>'s password stored in <parameter>buf</parameter> excluding the null
source code for an example. terminator. On failure, the callback should set
<literal>buf[0] = '\0'</literal> and return 0. See
<function>PQdefaultSSLKeyPassHook_OpenSSL</function> in
<application>libpq</application>'s source code for an example.
</para> </para>
<para> <para>
If the user specified an explicit key location, If the user specified an explicit key location,
its path will be in <literal>conn->pgsslkey</literal> when the callback its path will be in <literal>conn->sslkey</literal> when the callback
is invoked. This will be empty if the default key path is being used. is invoked. This will be empty if the default key path is being used.
For keys that are engine specifiers, it is up to engine implementations For keys that are engine specifiers, it is up to engine implementations
whether they use the OpenSSL password callback or define their own handling. whether they use the OpenSSL password callback or define their own handling.

View File

@ -4440,7 +4440,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
<structfield>name</structfield> <type>text</type> <structfield>name</structfield> <type>text</type>
</para> </para>
<para> <para>
name of the SLRU Name of the SLRU
</para></entry> </para></entry>
</row> </row>
@ -4644,7 +4644,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
argument. The argument can be <literal>bgwriter</literal> to reset argument. The argument can be <literal>bgwriter</literal> to reset
all the counters shown in all the counters shown in
the <structname>pg_stat_bgwriter</structname> the <structname>pg_stat_bgwriter</structname>
view,or <literal>archiver</literal> to reset all the counters shown in view, or <literal>archiver</literal> to reset all the counters shown in
the <structname>pg_stat_archiver</structname> view. the <structname>pg_stat_archiver</structname> view.
</para> </para>
<para> <para>
@ -5184,8 +5184,8 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
<row> <row>
<entry><literal>finalizing analyze</literal></entry> <entry><literal>finalizing analyze</literal></entry>
<entry> <entry>
The command is updating pg_class. When this phase is completed, The command is updating <structname>pg_class</structname>. When this
<command>ANALYZE</command> will end. phase is completed, <command>ANALYZE</command> will end.
</entry> </entry>
</row> </row>
</tbody> </tbody>

View File

@ -1742,8 +1742,9 @@ simple query protocol can be used.
<para> <para>
For the purpose of testing replication commands, you can make a replication For the purpose of testing replication commands, you can make a replication
connection via <application>psql</application> or any other <literal>libpq</literal>-using connection via <application>psql</application> or any other
tool with a connection string including the <literal>replication</literal> option, <application>libpq</application>-using tool with a connection string including
the <literal>replication</literal> option,
e.g.: e.g.:
<programlisting> <programlisting>
psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;" psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"