pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedMinor fixes for PostgreSQL 13 documentation
5+ messages / 3 participants
[nested] [flat]
Commits from this thread:
2020-08-24 77c1537f51 doc: Fix some markups for support functions of index AMs
2020-08-22 c3a288649e 610394c7b8 doc: Fix format, incorrect structure names and markup inconsistencies
* Minor fixes for PostgreSQL 13 documentation
@ 2020-08-22 10:10 Alexander Lakhin <exclusion@gmail.com>
0 siblings, 1 reply; 5+ messages in thread
From: Alexander Lakhin @ 2020-08-22 10:10 UTC (permalink / raw)
To: pgsql-docs
Hello,
Please consider applying fixes for bugs (incorrect tags, redundant
spaces, etc.) I noticed while translating the documentation.
Best regards,
Alexander
Attachments:
fix-doc-13-bugs.patch (text/x-patch, 7.6K) download
diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml
index d03ee4d6fa..435b7cb24d 100644
--- a/doc/src/sgml/btree.sgml
+++ b/doc/src/sgml/btree.sgml
@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
<synopsis>
options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void
</synopsis>
- The function is passed a pointer to a <replaceable>local_relopts</replaceable>
+ The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
diff --git a/doc/src/sgml/datetime.sgml b/doc/src/sgml/datetime.sgml
index bbf50b76f8..d466e09381 100644
--- a/doc/src/sgml/datetime.sgml
+++ b/doc/src/sgml/datetime.sgml
@@ -564,7 +564,7 @@
</indexterm>
<para>
- <acronym>PostgreSQL</acronym> can accept time zone specifications that
+ <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
@@ -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 b1c92196e2..800a5414d4 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -9236,7 +9236,7 @@ SELECT EXTRACT(CENTURY FROM TIMESTAMP '2001-02-16 20:38:40');
<listitem>
<para>
For <type>timestamp</type> values, the day (of the month) field
- (1–31) ; for <type>interval</type> values, the number of days
+ (1–31); for <type>interval</type> values, the number of days
</para>
<screen>
@@ -9460,7 +9460,7 @@ SELECT EXTRACT(MINUTE FROM TIMESTAMP '2001-02-16 20:38:40');
<listitem>
<para>
For <type>timestamp</type> values, the number of the month
- within the year (1–12) ; for <type>interval</type> values,
+ within the year (1–12); for <type>interval</type> values,
the number of months, modulo 12 (0–11)
</para>
@@ -14074,7 +14074,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 754581441f..3b954b54a2 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 5243f5f346..50f0612b43 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -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>
</para>
<para>
- name of the SLRU
+ Name of the SLRU
</para></entry>
</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
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>
@@ -5184,8 +5184,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>
* Re: Minor fixes for PostgreSQL 13 documentation
@ 2020-08-22 13:30 Michael Paquier <michael@paquier.xyz>
parent: Alexander Lakhin <exclusion@gmail.com>
0 siblings, 1 reply; 5+ messages in thread
From: Michael Paquier @ 2020-08-22 13:30 UTC (permalink / raw)
To: Alexander Lakhin <exclusion@gmail.com>; +Cc: pgsql-docs
On Sat, Aug 22, 2020 at 01:10:11PM +0300, Alexander Lakhin wrote:
> Please consider applying fixes for bugs (incorrect tags, redundant
> spaces, etc.) I noticed while translating the documentation.
Thanks, Alexander. I have applied and back-patched most of it down to
13.
> - The function is passed a pointer to a <replaceable>local_relopts</replaceable>
> + The function is passed a pointer to a <structname>local_relopts</structname>
The docs of brin, gin, gist and spgist disagree with that. Wouldn't
it be better to update all of them?
> - (1–31) ; for <type>interval</type> values, the number of days
> + (1–31); for <type>interval</type> values, the number of days
This one is visibly intentional, as of cbd2811.
> - <literal>libpq</literal>'s <link linkend="libpq-ssl-clientcert">default
> + <application>libpq</application>'s <link linkend="libpq-ssl-clientcert">default
I have found a second instance of that, so fixed on the way.
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Minor fixes for PostgreSQL 13 documentation
@ 2020-08-22 15:06 Tom Lane <tgl@sss.pgh.pa.us>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 1 reply; 5+ messages in thread
From: Tom Lane @ 2020-08-22 15:06 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: Alexander Lakhin <exclusion@gmail.com>; pgsql-docs
Michael Paquier <michael@paquier.xyz> writes:
> On Sat, Aug 22, 2020 at 01:10:11PM +0300, Alexander Lakhin wrote:
>> - The function is passed a pointer to a <replaceable>local_relopts</replaceable>
>> + The function is passed a pointer to a <structname>local_relopts</structname>
> The docs of brin, gin, gist and spgist disagree with that. Wouldn't
> it be better to update all of them?
Yeah, probably. See 47046763c for some policy I'd made up about when
to use <replaceable> --- typedef names definitely don't fit.
regards, tom lane
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: Minor fixes for PostgreSQL 13 documentation
@ 2020-08-23 12:11 Michael Paquier <michael@paquier.xyz>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 5+ messages in thread
From: Michael Paquier @ 2020-08-23 12:11 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Alexander Lakhin <exclusion@gmail.com>; pgsql-docs
On Sat, Aug 22, 2020 at 11:06:52AM -0400, Tom Lane wrote:
> Michael Paquier <michael@paquier.xyz> writes:
>> The docs of brin, gin, gist and spgist disagree with that. Wouldn't
>> it be better to update all of them?
>
> Yeah, probably. See 47046763c for some policy I'd made up about when
> to use <replaceable> --- typedef names definitely don't fit.
I have looked again at the documentation and found just the five
places mentioned previously, giving the attached.
--
Michael
Attachments:
doc-structname.patch (text/x-diff, 3.2K) download
diff --git a/doc/src/sgml/brin.sgml b/doc/src/sgml/brin.sgml
index 55b6272db6..b9d596e3c4 100644
--- a/doc/src/sgml/brin.sgml
+++ b/doc/src/sgml/brin.sgml
@@ -576,7 +576,7 @@ typedef struct BrinOpcInfo
<para>
The <function>options</function> function is passed a pointer to a
- <replaceable>local_relopts</replaceable> struct, which needs to be
+ <structname>local_relopts</structname> struct, which needs to be
filled with a set of operator class specific options. The options
can be accessed from other support functions using the
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml
index d03ee4d6fa..435b7cb24d 100644
--- a/doc/src/sgml/btree.sgml
+++ b/doc/src/sgml/btree.sgml
@@ -566,7 +566,7 @@ equalimage(<replaceable>opcintype</replaceable> <type>oid</type>) returns bool
<synopsis>
options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns void
</synopsis>
- The function is passed a pointer to a <replaceable>local_relopts</replaceable>
+ The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml
index 07114f7719..2d862669c3 100644
--- a/doc/src/sgml/gin.sgml
+++ b/doc/src/sgml/gin.sgml
@@ -412,7 +412,7 @@
<para>
The <function>options</function> function is passed a pointer to a
- <replaceable>local_relopts</replaceable> struct, which needs to be
+ <structname>local_relopts</structname> struct, which needs to be
filled with a set of operator class specific options. The options
can be accessed from other support functions using the
<literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index 5d970ee9f2..a505815f4e 100644
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -962,7 +962,7 @@ LANGUAGE C STRICT;
</para>
<para>
- The function is passed a pointer to a <replaceable>local_relopts</replaceable>
+ The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml
index 5d6e893d49..b86302e4ef 100644
--- a/doc/src/sgml/spgist.sgml
+++ b/doc/src/sgml/spgist.sgml
@@ -897,7 +897,7 @@ LANGUAGE C STRICT;
</para>
<para>
- The function is passed a pointer to a <replaceable>local_relopts</replaceable>
+ The function is passed a pointer to a <structname>local_relopts</structname>
struct, which needs to be filled with a set of operator class
specific options. The options can be accessed from other support
functions using the <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and
* Re: Minor fixes for PostgreSQL 13 documentation
@ 2020-08-24 08:02 Michael Paquier <michael@paquier.xyz>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 0 replies; 5+ messages in thread
From: Michael Paquier @ 2020-08-24 08:02 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Alexander Lakhin <exclusion@gmail.com>; pgsql-docs
On Sun, Aug 23, 2020 at 09:11:58PM +0900, Michael Paquier wrote:
> I have looked again at the documentation and found just the five
> places mentioned previously, giving the attached.
And fixed with 77c1537, so we are done here.
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 5+ messages in thread
end of thread, other threads:[~2020-08-24 08:02 UTC | newest]
Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-08-22 10:10 Minor fixes for PostgreSQL 13 documentation Alexander Lakhin <exclusion@gmail.com>
2020-08-22 13:30 ` Michael Paquier <michael@paquier.xyz>
2020-08-22 15:06 ` Tom Lane <tgl@sss.pgh.pa.us>
2020-08-23 12:11 ` Michael Paquier <michael@paquier.xyz>
2020-08-24 08:02 ` Michael Paquier <michael@paquier.xyz>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox