From 610394c7b876bc841464aad38f8abed09d63924e Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Sat, 22 Aug 2020 22:26:18 +0900 Subject: [PATCH] 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 --- doc/src/sgml/datetime.sgml | 8 ++++---- doc/src/sgml/func.sgml | 2 +- doc/src/sgml/libpq.sgml | 27 +++++++++++++++------------ doc/src/sgml/monitoring.sgml | 8 ++++---- doc/src/sgml/protocol.sgml | 5 +++-- 5 files changed, 27 insertions(+), 23 deletions(-) diff --git a/doc/src/sgml/datetime.sgml b/doc/src/sgml/datetime.sgml index bbf50b76f8..39fbc39cb0 100644 --- a/doc/src/sgml/datetime.sgml +++ b/doc/src/sgml/datetime.sgml @@ -564,8 +564,8 @@ - PostgreSQL can accept time zone specifications that - are written according to the POSIX standard's rules + PostgreSQL can accept time zone specifications + that are written according to the POSIX standard's rules for the TZ environment variable. POSIX time zone specifications are inadequate to deal with the complexity of real-world time zone history, @@ -635,8 +635,8 @@ or -). The positive sign is used for zones west of Greenwich. (Note that this is the opposite of the ISO-8601 sign convention used elsewhere in - PostgreSQL.) hh can have - one or two digits; mm + PostgreSQL.) hh + can have one or two digits; mm and ss (if used) must have two. diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index b1c92196e2..9dcb823326 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -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..15923407cf 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -781,7 +781,7 @@ PGPing PQping(const char *conninfo); PQsetSSLKeyPassHook_OpenSSL lets an application override - libpq's default + libpq's default handling of encrypted client certificate key files using or interactive prompting. @@ -793,20 +793,23 @@ void PQsetSSLKeyPassHook_OpenSSL(PQsslKeyPassHook_OpenSSL_type hook); int callback_fn(char *buf, int size, PGconn *conn); - which libpq will then call instead of - its default PQdefaultSSLKeyPassHook_OpenSSL handler. The callback - should determine the password for the key and copy it to result-buffer - buf of size size. The string in - buf must be null-terminated. The callback must return the length of - the password stored in buf excluding the null terminator. - On failure, the callback should set buf[0] = '\0' and return 0. - See PQdefaultSSLKeyPassHook_OpenSSL in libpq's - source code for an example. + which libpq will then call + instead of its default + PQdefaultSSLKeyPassHook_OpenSSL handler. The + callback should determine the password for the key and copy it to + result-buffer buf of size + size. The string in buf + must be null-terminated. The callback must return the length of the + password stored in buf excluding the null + terminator. On failure, the callback should set + buf[0] = '\0' and return 0. See + PQdefaultSSLKeyPassHook_OpenSSL in + libpq's source code for an example. - + If the user specified an explicit key location, - its path will be in conn->pgsslkey when the callback + its path will be in conn->sslkey 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 name text - name of the SLRU + Name of the SLRU @@ -4644,7 +4644,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i argument. The argument can be bgwriter to reset all the counters shown in the pg_stat_bgwriter - view,or archiver to reset all the counters shown in + view, or archiver to reset all the counters shown in the pg_stat_archiver view. @@ -5184,8 +5184,8 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid, finalizing analyze - The command is updating pg_class. When this phase is completed, - ANALYZE will end. + The command is updating pg_class. When this + phase is completed, ANALYZE will end. diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 20d1fe0ad8..b7e8bfa6ff 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1742,8 +1742,9 @@ simple query protocol can be used. For the purpose of testing replication commands, you can make a replication - connection via psql or any other libpq-using - tool with a connection string including the replication option, + connection via psql or any other + libpq-using tool with a connection string including + the replication option, e.g.: psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"