aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2020-08-22 22:26:10 +0900
committerMichael Paquier <michael@paquier.xyz>2020-08-22 22:26:10 +0900
commitc3a288649e152612791121fa6d17a1322b8f2814 (patch)
treeff10851ea9dd9f00f853d24b2ba125ae8a90e915
parent2a9f37243b0b0b3621f1851a6a8644d4ca2749d6 (diff)
downloadpostgresql-c3a288649e152612791121fa6d17a1322b8f2814.tar.gz
postgresql-c3a288649e152612791121fa6d17a1322b8f2814.zip
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
-rw-r--r--doc/src/sgml/datetime.sgml8
-rw-r--r--doc/src/sgml/func.sgml2
-rw-r--r--doc/src/sgml/libpq.sgml29
-rw-r--r--doc/src/sgml/monitoring.sgml8
-rw-r--r--doc/src/sgml/protocol.sgml5
5 files changed, 28 insertions, 24 deletions
diff --git a/doc/src/sgml/datetime.sgml b/doc/src/sgml/datetime.sgml
index bbf50b76f8c..39fbc39cb0d 100644
--- a/doc/src/sgml/datetime.sgml
+++ b/doc/src/sgml/datetime.sgml
@@ -564,8 +564,8 @@
</indexterm>
<para>
- <acronym>PostgreSQL</acronym> can accept time zone specifications that
- are written according to the <acronym>POSIX</acronym> standard's rules
+ <productname>PostgreSQL</productname> can accept time zone specifications
+ that are written according to the <acronym>POSIX</acronym> standard's rules
for the <varname>TZ</varname> environment
variable. <acronym>POSIX</acronym> time zone specifications are
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
zones <emphasis>west</emphasis> of Greenwich. (Note that this is the
opposite of the ISO-8601 sign convention used elsewhere in
- <acronym>PostgreSQL</acronym>.) <replaceable>hh</replaceable> can have
- one or two digits; <replaceable>mm</replaceable>
+ <productname>PostgreSQL</productname>.) <replaceable>hh</replaceable>
+ can have one or two digits; <replaceable>mm</replaceable>
and <replaceable>ss</replaceable> (if used) must have two.
</para>
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 9a4ac5a1ea3..51ec5281c0b 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -14101,7 +14101,7 @@ SELECT xmltable.*
size_sq_km float PATH 'SIZE[@unit = "sq_km"]',
size_other text PATH
'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
----+------------+--------------+------------+------------+--------------+---------------
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index f7b765f76dc..72c42407790 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -781,7 +781,7 @@ PGPing PQping(const char *conninfo);
<listitem>
<para>
<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
<xref linkend="libpq-connect-sslpassword"/> or interactive prompting.
@@ -793,20 +793,23 @@ void PQsetSSLKeyPassHook_OpenSSL(PQsslKeyPassHook_OpenSSL_type hook);
<programlisting>
int callback_fn(char *buf, int size, PGconn *conn);
</programlisting>
- which <literal>libpq</literal> will then call <emphasis>instead of</emphasis>
- its default <function>PQdefaultSSLKeyPassHook_OpenSSL</function> handler. The callback
- should determine the password for the key and copy it to result-buffer
- <literal>buf</literal> of size <literal>size</literal>. The string in <literal>
- buf</literal> must be null-terminated. The callback must return the length of
- the password stored in <literal>buf</literal> excluding the null terminator.
- On failure, the callback should set <literal>buf[0] = '\0'</literal> and return 0.
- See <function>PQdefaultSSLKeyPassHook_OpenSSL</function> in <literal>libpq</literal>'s
- source code for an example.
- </para>
-
+ which <application>libpq</application> will then call
+ <emphasis>instead of</emphasis> its default
+ <function>PQdefaultSSLKeyPassHook_OpenSSL</function> handler. The
+ callback should determine the password for the key and copy it to
+ result-buffer <parameter>buf</parameter> of size
+ <parameter>size</parameter>. The string in <parameter>buf</parameter>
+ must be null-terminated. The callback must return the length of the
+ password stored in <parameter>buf</parameter> excluding the null
+ 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>
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.
For keys that are engine specifiers, it is up to engine implementations
whether they use the OpenSSL password callback or define their own handling.
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index 304c49f07b7..0f11375c852 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -4444,7 +4444,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
<structfield>name</structfield> <type>text</type>
</para>
<para>
- name of the SLRU
+ Name of the SLRU
</para></entry>
</row>
@@ -4648,7 +4648,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
all the counters shown in
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.
</para>
<para>
@@ -5188,8 +5188,8 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
<row>
<entry><literal>finalizing analyze</literal></entry>
<entry>
- The command is updating pg_class. When this phase is completed,
- <command>ANALYZE</command> will end.
+ The command is updating <structname>pg_class</structname>. When this
+ phase is completed, <command>ANALYZE</command> will end.
</entry>
</row>
</tbody>
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 8b00235a516..0c7087397d7 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -1742,8 +1742,9 @@ simple query protocol can be used.
<para>
For the purpose of testing replication commands, you can make a replication
- connection via <application>psql</application> or any other <literal>libpq</literal>-using
- tool with a connection string including the <literal>replication</literal> option,
+ connection via <application>psql</application> or any other
+ <application>libpq</application>-using tool with a connection string including
+ the <literal>replication</literal> option,
e.g.:
<programlisting>
psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"