Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit c3a2886

Browse files
committed
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
1 parent 2a9f372 commit c3a2886

File tree

5 files changed

+28
-24
lines changed

5 files changed

+28
-24
lines changed

doc/src/sgml/datetime.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,8 @@
564564
</indexterm>
565565

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

doc/src/sgml/func.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14101,7 +14101,7 @@ SELECT xmltable.*
1410114101
size_sq_km float PATH 'SIZE[@unit = "sq_km"]',
1410214102
size_other text PATH
1410314103
'concat(SIZE[@unit!="sq_km"], " ", SIZE[@unit!="sq_km"]/@unit)',
14104-
premier_name text PATH 'PREMIER_NAME' DEFAULT 'not specified') ;
14104+
premier_name text PATH 'PREMIER_NAME' DEFAULT 'not specified');
1410514105

1410614106
id | ordinality | COUNTRY_NAME | country_id | size_sq_km | size_other | premier_name
1410714107
----+------------+--------------+------------+------------+--------------+---------------

doc/src/sgml/libpq.sgml

+16-13
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,7 @@ PGPing PQping(const char *conninfo);
781781
<listitem>
782782
<para>
783783
<function>PQsetSSLKeyPassHook_OpenSSL</function> lets an application override
784-
<literal>libpq</literal>'s <link linkend="libpq-ssl-clientcert">default
784+
<application>libpq</application>'s <link linkend="libpq-ssl-clientcert">default
785785
handling of encrypted client certificate key files</link> using
786786
<xref linkend="libpq-connect-sslpassword"/> or interactive prompting.
787787

@@ -793,20 +793,23 @@ void PQsetSSLKeyPassHook_OpenSSL(PQsslKeyPassHook_OpenSSL_type hook);
793793
<programlisting>
794794
int callback_fn(char *buf, int size, PGconn *conn);
795795
</programlisting>
796-
which <literal>libpq</literal> will then call <emphasis>instead of</emphasis>
797-
its default <function>PQdefaultSSLKeyPassHook_OpenSSL</function> handler. The callback
798-
should determine the password for the key and copy it to result-buffer
799-
<literal>buf</literal> of size <literal>size</literal>. The string in <literal>
800-
buf</literal> must be null-terminated. The callback must return the length of
801-
the password stored in <literal>buf</literal> excluding the null terminator.
802-
On failure, the callback should set <literal>buf[0] = '\0'</literal> and return 0.
803-
See <function>PQdefaultSSLKeyPassHook_OpenSSL</function> in <literal>libpq</literal>'s
804-
source code for an example.
805-
</para>
806-
796+
which <application>libpq</application> will then call
797+
<emphasis>instead of</emphasis> its default
798+
<function>PQdefaultSSLKeyPassHook_OpenSSL</function> handler. The
799+
callback should determine the password for the key and copy it to
800+
result-buffer <parameter>buf</parameter> of size
801+
<parameter>size</parameter>. The string in <parameter>buf</parameter>
802+
must be null-terminated. The callback must return the length of the
803+
password stored in <parameter>buf</parameter> excluding the null
804+
terminator. On failure, the callback should set
805+
<literal>buf[0] = '\0'</literal> and return 0. See
806+
<function>PQdefaultSSLKeyPassHook_OpenSSL</function> in
807+
<application>libpq</application>'s source code for an example.
808+
</para>
809+
807810
<para>
808811
If the user specified an explicit key location,
809-
its path will be in <literal>conn->pgsslkey</literal> when the callback
812+
its path will be in <literal>conn->sslkey</literal> when the callback
810813
is invoked. This will be empty if the default key path is being used.
811814
For keys that are engine specifiers, it is up to engine implementations
812815
whether they use the OpenSSL password callback or define their own handling.

doc/src/sgml/monitoring.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4444,7 +4444,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
44444444
<structfield>name</structfield> <type>text</type>
44454445
</para>
44464446
<para>
4447-
name of the SLRU
4447+
Name of the SLRU
44484448
</para></entry>
44494449
</row>
44504450

@@ -4648,7 +4648,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
46484648
argument. The argument can be <literal>bgwriter</literal> to reset
46494649
all the counters shown in
46504650
the <structname>pg_stat_bgwriter</structname>
4651-
view,or <literal>archiver</literal> to reset all the counters shown in
4651+
view, or <literal>archiver</literal> to reset all the counters shown in
46524652
the <structname>pg_stat_archiver</structname> view.
46534653
</para>
46544654
<para>
@@ -5188,8 +5188,8 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
51885188
<row>
51895189
<entry><literal>finalizing analyze</literal></entry>
51905190
<entry>
5191-
The command is updating pg_class. When this phase is completed,
5192-
<command>ANALYZE</command> will end.
5191+
The command is updating <structname>pg_class</structname>. When this
5192+
phase is completed, <command>ANALYZE</command> will end.
51935193
</entry>
51945194
</row>
51955195
</tbody>

doc/src/sgml/protocol.sgml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1742,8 +1742,9 @@ simple query protocol can be used.
17421742

17431743
<para>
17441744
For the purpose of testing replication commands, you can make a replication
1745-
connection via <application>psql</application> or any other <literal>libpq</literal>-using
1746-
tool with a connection string including the <literal>replication</literal> option,
1745+
connection via <application>psql</application> or any other
1746+
<application>libpq</application>-using tool with a connection string including
1747+
the <literal>replication</literal> option,
17471748
e.g.:
17481749
<programlisting>
17491750
psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"

0 commit comments

Comments
 (0)