pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedminor doc fixes for REL_12_STABLE
5+ messages / 3 participants
[nested] [flat]
Commits from this thread:
2019-08-20 d38753c6f7 93dcec96ef 15ae1a31b4 3399b345f1 7ffd4f3996 fbfa2bba86 Doc: Fix various typos
2019-08-20 0431a78746 b298e37013 Doc: Improve wording of multiple places in documentation
* minor doc fixes for REL_12_STABLE
@ 2019-08-19 14:12 Liudmila Mantrova <l.mantrova@gmail.com>
0 siblings, 1 reply; 5+ messages in thread
From: Liudmila Mantrova @ 2019-08-19 14:12 UTC (permalink / raw)
To: pgsql-docs
Hi,
Please consider the attached patches that fix some documentation
inconsistencies in REL_12_STABLE branch. The first one contains fixes of
typos and tagging issues that were discovered during new content
translation. The other is a back-patch of fixes already accepted in master
after REL_12_STABLE has been created (originally reported by Alexander
Lakhin in "Fix typos and inconsistencies for HEAD" series).
--
Best regards,
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
Attachments: download all (2 files, .tar.gz)
v12-changes-from-master.patch (text/x-patch, 9.7K) download
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 0e22dcc31b..5e71a2e865 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -11031,7 +11031,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<entry><structfield>kinds</structfield></entry>
<entry><type>text[]</type></entry>
<entry></entry>
- <entry>Types of exdended statistics enabled for this record</entry>
+ <entry>Types of extended statistics enabled for this record</entry>
</row>
<row>
diff --git a/doc/src/sgml/custom-scan.sgml b/doc/src/sgml/custom-scan.sgml
index ab9b055d9a..b8963a28eb 100644
--- a/doc/src/sgml/custom-scan.sgml
+++ b/doc/src/sgml/custom-scan.sgml
@@ -83,10 +83,7 @@ typedef struct CustomPath
by <literal>nodeToString</literal>, so that debugging routines that attempt to
print the custom path will work as designed. <structfield>methods</structfield> must
point to a (usually statically allocated) object implementing the required
- custom path methods, of which there is currently only one. The
- <structfield>LibraryName</structfield> and <structfield>SymbolName</structfield> fields must also
- be initialized so that the dynamic loader can resolve them to locate the
- method table.
+ custom path methods, of which there is currently only one.
</para>
<para>
diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml
index bc8570363c..fa34e5500f 100644
--- a/doc/src/sgml/ecpg.sgml
+++ b/doc/src/sgml/ecpg.sgml
@@ -5011,7 +5011,7 @@ struct
<para>
The fields <structfield>sqlcaid</structfield>,
- <structfield>sqlcabc</structfield>,
+ <structfield>sqlabc</structfield>,
<structfield>sqlerrp</structfield>, and the remaining elements of
<structfield>sqlerrd</structfield> and
<structfield>sqlwarn</structfield> currently contain no useful
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 4bb5461484..169a01fc1a 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -2893,7 +2893,7 @@
</row>
<row>
- <entry><literal>tcvn_to_utf8</literal></entry>
+ <entry><literal>windows_1258_to_utf8</literal></entry>
<entry><literal>WIN1258</literal></entry>
<entry><literal>UTF8</literal></entry>
</row>
@@ -3061,7 +3061,7 @@
</row>
<row>
- <entry><literal>utf8_to_tcvn</literal></entry>
+ <entry><literal>utf8_to_windows_1258</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1258</literal></entry>
</row>
diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index 44a3b2c03c..beed6521eb 100644
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -696,8 +696,8 @@ my_picksplit(PG_FUNCTION_ARGS)
/*
* Choose where to put the index entries and update unionL and unionR
- * accordingly. Append the entries to either v_spl_left or
- * v_spl_right, and care about the counters.
+ * accordingly. Append the entries to either v->spl_left or
+ * v->spl_right, and care about the counters.
*/
if (my_choice_is_left(unionL, curl, unionR, curr))
@@ -910,7 +910,7 @@ Datum
my_fetch(PG_FUNCTION_ARGS)
{
GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
- input_data_type *in = DatumGetP(entry->key);
+ input_data_type *in = DatumGetPointer(entry->key);
fetched_data_type *fetched_data;
GISTENTRY *retval;
@@ -921,7 +921,7 @@ my_fetch(PG_FUNCTION_ARGS)
* Convert 'fetched_data' into the a Datum of the original datatype.
*/
- /* fill *retval from fetch_data. */
+ /* fill *retval from fetched_data. */
gistentryinit(*retval, PointerGetDatum(converted_datum),
entry->rel, entry->page, entry->offset, FALSE);
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index fded8d3b4b..d0f30a075f 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -5913,7 +5913,7 @@ int PQendcopy(PGconn *conn);
It should either be issued when the last string has been sent
to the server using <function>PQputline</function> or when the
last string has been received from the server using
- <function>PGgetline</function>. It must be issued or the server
+ <function>PQgetline</function>. It must be issued or the server
will get <quote>out of sync</quote> with the client. Upon return
from this function, the server is ready to receive the next SQL
command. The return value is 0 on successful completion,
diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml
index ef1556be8f..ae73630a48 100644
--- a/doc/src/sgml/plpgsql.sgml
+++ b/doc/src/sgml/plpgsql.sgml
@@ -3740,9 +3740,9 @@ RAISE unique_violation USING MESSAGE = 'Duplicate user ID: ' || user_id;
<para>
If no condition name nor SQLSTATE is specified in a
<command>RAISE EXCEPTION</command> command, the default is to use
- <literal>RAISE_EXCEPTION</literal> (<literal>P0001</literal>). If no message
- text is specified, the default is to use the condition name or
- SQLSTATE as message text.
+ <literal>ERRCODE_RAISE_EXCEPTION</literal> (<literal>P0001</literal>).
+ If no message text is specified, the default is to use the condition
+ name or SQLSTATE as message text.
</para>
<note>
@@ -5626,7 +5626,7 @@ BEGIN
INSERT INTO cs_active_job(job_id) VALUES (v_job_id);
BEGIN
- INSERT INTO cs_jobs (job_id, start_stamp) VALUES (v_job_id, sysdate);
+ INSERT INTO cs_jobs (job_id, start_stamp) VALUES (v_job_id, now());
EXCEPTION
WHEN dup_val_on_index THEN NULL; -- don't worry if it already exists
END;
diff --git a/doc/src/sgml/problems.sgml b/doc/src/sgml/problems.sgml
index 02ed975ec2..cf43262872 100644
--- a/doc/src/sgml/problems.sgml
+++ b/doc/src/sgml/problems.sgml
@@ -252,7 +252,7 @@
C library, processor, memory information, and so on. In most
cases it is sufficient to report the vendor and version, but do
not assume everyone knows what exactly <quote>Debian</quote>
- contains or that everyone runs on i386s. If you have
+ contains or that everyone runs on x86_64. If you have
installation problems then information about the toolchain on
your machine (compiler, <application>make</application>, and so
on) is also necessary.
diff --git a/doc/src/sgml/ref/create_aggregate.sgml b/doc/src/sgml/ref/create_aggregate.sgml
index ca0e9db8b1..644657dd5e 100644
--- a/doc/src/sgml/ref/create_aggregate.sgml
+++ b/doc/src/sgml/ref/create_aggregate.sgml
@@ -211,7 +211,7 @@ CREATE [ OR REPLACE ] AGGREGATE <replaceable class="parameter">name</replaceable
as described in <xref linkend="xaggr-moving-aggregates"/>. This requires
specifying the <literal>MSFUNC</literal>, <literal>MINVFUNC</literal>,
and <literal>MSTYPE</literal> parameters, and optionally
- the <literal>MSPACE</literal>, <literal>MFINALFUNC</literal>,
+ the <literal>MSSPACE</literal>, <literal>MFINALFUNC</literal>,
<literal>MFINALFUNC_EXTRA</literal>, <literal>MFINALFUNC_MODIFY</literal>,
and <literal>MINITCOND</literal> parameters. Except for <literal>MINVFUNC</literal>,
these parameters work like the corresponding simple-aggregate parameters
diff --git a/doc/src/sgml/ref/set_role.sgml b/doc/src/sgml/ref/set_role.sgml
index 0ef6eb9a9c..9ab0d6af04 100644
--- a/doc/src/sgml/ref/set_role.sgml
+++ b/doc/src/sgml/ref/set_role.sgml
@@ -70,7 +70,7 @@ RESET ROLE
effectively drops all the privileges assigned directly to the session user
and to the other roles it is a member of, leaving only the privileges
available to the named role. On the other hand, if the session user role
- has the <literal>NOINHERITS</literal> attribute, <command>SET ROLE</command> drops the
+ has the <literal>NOINHERIT</literal> attribute, <command>SET ROLE</command> drops the
privileges assigned directly to the session user and instead acquires the
privileges available to the named role.
</para>
diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index a339ebbc4b..6294312ab7 100644
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -884,7 +884,7 @@ BETTER: unrecognized node type: 42
features can be used, if a fallback is provided.
</para>
<para>
- For example <literal>_StaticAssert()</literal> and
+ For example <literal>_Static_assert()</literal> and
<literal>__builtin_constant_p</literal> are currently used, even though
they are from newer revisions of the C standard and a
<productname>GCC</productname> extension respectively. If not available
diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml
index 0fde0fc10e..78ff83d642 100644
--- a/doc/src/sgml/sslinfo.sgml
+++ b/doc/src/sgml/sslinfo.sgml
@@ -185,7 +185,7 @@ countryName (alias C)
localityName (alias L)
stateOrProvinceName (alias ST)
organizationName (alias O)
-organizationUnitName (alias OU)
+organizationalUnitName (alias OU)
title
description
initials
diff --git a/doc/src/sgml/xplang.sgml b/doc/src/sgml/xplang.sgml
index d215ce82d0..60e0430751 100644
--- a/doc/src/sgml/xplang.sgml
+++ b/doc/src/sgml/xplang.sgml
@@ -137,7 +137,7 @@ CREATE FUNCTION <replaceable>validator_function_name</replaceable>(oid)
<para>
Finally, the PL must be declared with the command
<synopsis>
-CREATE <optional>TRUSTED</optional> LANGUAGE <replaceable>language-name</replaceable>
+CREATE <optional>TRUSTED</optional> LANGUAGE <replaceable>language_name</replaceable>
HANDLER <replaceable>handler_function_name</replaceable>
<optional>INLINE <replaceable>inline_function_name</replaceable></optional>
<optional>VALIDATOR <replaceable>validator_function_name</replaceable></optional> ;
v12-doc-fixes.patch (text/x-patch, 20.3K) download
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 0e308e5f2c..0e22dcc31b 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -3017,9 +3017,9 @@ SCRAM-SHA-256$<replaceable><iteration count></replaceable>:<replaceable>&l
A <command>DROP</command> of the referenced object will result in
automatically dropping the dependent object
whether <literal>CASCADE</literal> is specified or not. If the
- dependent object is reached due to a dependency on some other object,
- the drop is converted to a drop of the referenced object, so
- that <literal>NORMAL</literal> and <literal>AUTO</literal>
+ dependent object has to be dropped due to a dependency on some other
+ object being removed, its drop is converted to a drop of the referenced
+ object, so that <literal>NORMAL</literal> and <literal>AUTO</literal>
dependencies of the dependent object behave much like they were
dependencies of the referenced object.
Example: a view's <literal>ON SELECT</literal> rule is made
@@ -10967,7 +10967,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<para>
<structname>pg_stats_ext</structname> is also designed to present the
- information in a more readable format than the underlying catalog
+ information in a more readable format than the underlying catalogs
— at the cost that its schema must be extended whenever new types
of extended statistics are added to <structname>pg_statistic_ext</structname>.
</para>
@@ -11024,7 +11024,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<entry><structfield>attnames</structfield></entry>
<entry><type>name[]</type></entry>
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attname</literal></entry>
- <entry>Names of the column the extended statistics is defined on</entry>
+ <entry>Names of the columns the extended statistics is defined on</entry>
</row>
<row>
@@ -11038,9 +11038,9 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<entry><structfield>n_distinct</structfield></entry>
<entry><type>pg_ndistinct</type></entry>
<entry></entry>
- <entry>N-distinct counts for combinations of columns. If greater than
- zero, the estimated number of distinct values in the combination. If
- less than zero, the negative of the number of distinct values divided
+ <entry>N-distinct counts for combinations of column values. If greater
+ than zero, the estimated number of distinct values in the combination.
+ If less than zero, the negative of the number of distinct values divided
by the number of rows.
(The negated form is used when <command>ANALYZE</command> believes that
the number of distinct values is likely to increase as the table grows;
@@ -11063,8 +11063,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<entry><type>anyarray</type></entry>
<entry></entry>
<entry>
- A list of the most common combinations in the columns. (Null if
- no values seem to be more common than any others.)
+ A list of the most common combinations of values in the columns.
+ (Null if no combinations seem to be more common than any others.)
</entry>
</row>
diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml
index fada7289d4..9236fc014c 100644
--- a/doc/src/sgml/client-auth.sgml
+++ b/doc/src/sgml/client-auth.sgml
@@ -196,7 +196,8 @@ hostnogssenc <replaceable>database</replaceable> <replaceable>user</replaceable
</para>
<para>
- Note that the only supported <xref linkend="auth-methods"/> for use
+ Note that the only supported
+ <link linkend="auth-methods">authentication methods</link> for use
with <acronym>GSSAPI</acronym> encryption
are <literal>gss</literal>, <literal>reject</literal>,
and <literal>trust</literal>.
@@ -489,7 +490,7 @@ hostnogssenc <replaceable>database</replaceable> <replaceable>user</replaceable
<listitem>
<para>
Use GSSAPI to authenticate the user. This is only
- available for TCP/IP connections . See <xref
+ available for TCP/IP connections. See <xref
linkend="gssapi-auth"/> for details. It can be used in conjunction
with GSSAPI encryption.
</para>
@@ -610,8 +611,8 @@ hostnogssenc <replaceable>database</replaceable> <replaceable>user</replaceable
<literal>verify-full</literal> additionally enforces that the
<literal>cn</literal> (Common Name) in the certificate matches
the username or an applicable mapping.
- This behavior is similar to the cert authentication method
- (see <xref linkend="auth-cert"/> ) but enables pairing
+ This behavior is similar to the <literal>cert</literal> authentication
+ method (see <xref linkend="auth-cert"/>) but enables pairing
the verification of client certificates with any authentication
method that supports <literal>hostssl</literal> entries.
</para>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index e99482d399..deea5093f5 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -3146,29 +3146,29 @@ include_dir 'conf.d'
</para>
<para>
- To start the server in standby mode create file called
+ To start the server in standby mode, create a file called
<filename>standby.signal</filename><indexterm><primary>standby.signal</primary></indexterm>
in the data directory. The server will enter recovery and will not stop
recovery when the end of archived WAL is reached, but will keep trying to
continue recovery by connecting to the sending server as specified by the
<varname>primary_conninfo</varname> setting and/or by fetching new WAL
- segments using <varname>restore_command</varname>. In this mode, you may
+ segments using <varname>restore_command</varname>. In this mode, you can
use parameters in both <xref
linkend="runtime-config-wal-archive-recovery"/> and <xref
- linkend="runtime-config-replication-standby"/> sections. Parameters from
+ linkend="runtime-config-replication-standby"/>. Parameters from
<xref linkend="runtime-config-wal-recovery-target"/> will not be used.
</para>
<para>
- To start the server in targeted recovery create a file called
+ To start the server in targeted recovery mode, create a file called
<filename>recovery.signal</filename><indexterm><primary>recovery.signal</primary></indexterm>
in the data directory. If both <filename>standby.signal</filename> and
<filename>recovery.signal</filename> files are created, standby mode
- takes precedence. Targeted recovery mode will end when end of archived
- WAL is reached, or when <varname>recovery_target</varname> is reached.
- In this mode you may use parameters from both <xref
+ takes precedence. Targeted recovery mode ends when the archived WAL is
+ fully replayed, or when <varname>recovery_target</varname> is reached.
+ In this mode, you can use parameters from both <xref
linkend="runtime-config-wal-archive-recovery"/> and <xref
- linkend="runtime-config-wal-recovery-target"/> sections. Parameters from <xref
+ linkend="runtime-config-wal-recovery-target"/>. Parameters from <xref
linkend="runtime-config-replication-standby"/> will not be used.
</para>
@@ -8032,8 +8032,9 @@ SET XML OPTION { DOCUMENT | CONTENT };
given decimal precision. The precision used is the standard number of
digits for the type (<literal>FLT_DIG</literal>
or <literal>DBL_DIG</literal> as appropriate) reduced according to the
- value of this parameter. (For example, specifying -1 will cause float4
- values to be output rounded to 5 significant digits, and float8 values
+ value of this parameter. (For example, specifying -1 will cause
+ <type>float4</type> values to be output rounded to 5 significant
+ digits, and <type>float8</type> values
rounded to 14 digits.) This format is slower and does not preserve all
the bits of the binary float value, but may be more human-readable.
</para>
@@ -9201,7 +9202,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</term>
<listitem>
<para>
- Reports the name of the SSL library that this PostgreSQL server was
+ Reports the name of the SSL library that this <productname>PostgreSQL</productname> server was
built with (even if SSL is not currently configured or in use on this
instance), for example <literal>OpenSSL</literal>, or an empty string
if none.
diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml
index 6641eee440..bc8570363c 100644
--- a/doc/src/sgml/ecpg.sgml
+++ b/doc/src/sgml/ecpg.sgml
@@ -312,14 +312,14 @@ current=testdb1 (should be testdb1)
</para>
<para>
- The third option is to declare a sql identifier linked to
+ The third option is to declare an SQL identifier linked to
the connection, for example:
<programlisting>
EXEC SQL AT <replaceable>connection-name</replaceable> DECLARE <replaceable>statement-name</replaceable> STATEMENT;
EXEC SQL PREPARE <replaceable>statement-name</replaceable> FROM :<replaceable>dyn-string</replaceable>;
</programlisting>
- Once you link a sql identifier to a connection, you execute a dynamic SQL
- without AT clause.
+ Once you link an SQL identifier to a connection, execute dynamic SQL
+ statements using this identifier without the <literal>AT</literal> clause.
</para>
</sect2>
@@ -1209,8 +1209,8 @@ EXEC SQL END DECLARE SECTION;
<title id="ecpg-type-bytea">bytea</title>
<para>
- The handling of the <type>bytea</type> type is also similar to
- the <type>VARCHAR</type>. The definition on an array of type
+ The handling of the <type>bytea</type> type is similar to
+ that of <type>VARCHAR</type>. The definition on an array of type
<type>bytea</type> is converted into a named struct for every
variable. A declaration like:
<programlisting>
@@ -1221,8 +1221,8 @@ bytea var[180];
struct bytea_var { int len; char arr[180]; } var;
</programlisting>
The member <structfield>arr</structfield> hosts binary format
- data. It also can handle even <literal>'\0'</literal> as part of
- data unlike <type>VARCHAR</type>.
+ data. It can also handle <literal>'\0'</literal> as part of
+ data, unlike <type>VARCHAR</type>.
The data is converted from/to hex format and sent/received by
ecpglib.
</para>
@@ -6810,7 +6810,7 @@ EXEC SQL DECLARE cur1 CURSOR FOR stmt1;
<refentry id="ecpg-sql-declare-statement">
<refnamediv>
<refname>DECLARE STATEMENT</refname>
- <refpurpose>declares SQL statement identifier associated with connection</refpurpose>
+ <refpurpose>declares an SQL statement identifier associated with connection</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -6823,12 +6823,13 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
<title>Description</title>
<para>
- <command>DECLARE STATEMENT</command> declares SQL statement identifier.
- SQL statement identifier is associated with connection.
+ <command>DECLARE STATEMENT</command> declares an SQL statement identifier
+ to be associated with connection.
</para>
<para>
- <command>DECLARE CURSOR</command> with a SQL statement identifier can be written before PREPARE.
+ <command>DECLARE CURSOR</command> with an SQL statement identifier
+ can be written before <command>PREPARE</command>.
</para>
</refsect1>
@@ -6843,7 +6844,8 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
A database connection name established by the <command>CONNECT</command> command.
</para>
<para>
- If AT clause is omitted, an SQL statement identifier is associated with the DEFAULT connection.
+ If the <literal>AT</literal> clause is omitted, the SQL statement
+ identifier is associated with the <literal>DEFAULT</literal> connection.
</para>
</listitem>
</varlistentry>
@@ -6854,7 +6856,8 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
<term><replaceable class="parameter">statement_name</replaceable></term>
<listitem>
<para>
- The name of a SQL statement identifier, either as an SQL identifier or a host variable.
+ The name of the SQL statement identifier, either as an SQL identifier
+ or a host variable.
</para>
</listitem>
</varlistentry>
@@ -6864,9 +6867,10 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
<refsect1>
<title>Notes</title>
<para>
- AT clause can be used at other dynamic SQL statements. The following table
- gives the connected database when AT clause is used at DECLARE STATEMENT
- and other dynamic statements.
+ The <literal>AT</literal> clause can be used with both
+ <command>DECLARE STATEMENT</command> and other dynamic SQL statements.
+ The following table illustrates how it affects the selected database
+ connection.
</para>
<table tocentry="1" id="ecpg-declare-statement-table">
<title>Scenario</title>
@@ -6874,16 +6878,16 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
<thead>
<row>
<entry>
- Using Scenario
+ Usage Scenario
</entry>
<entry>
- Declare Statement
+ DECLARE STATEMENT
</entry>
<entry>
Other Dynamic Statements
</entry>
<entry>
- Executed Database
+ Target Database
</entry>
</row>
</thead>
@@ -6893,10 +6897,10 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
1
</entry>
<entry>
- Without AT clause
+ Without <literal>AT</literal>
</entry>
<entry>
- Without AT clause
+ Without <literal>AT</literal>
</entry>
<entry>
Default connection
@@ -6907,10 +6911,10 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
2
</entry>
<entry>
- Using AT clause connecting at con1
+ With <literal>AT</literal> that connects to <literal>con1</literal>
</entry>
<entry>
- Without AT clause
+ Without <literal>AT</literal>
</entry>
<entry>
con1
@@ -6921,10 +6925,10 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
3
</entry>
<entry>
- Using AT clause connecting at con1
+ With <literal>AT</literal> that connects to <literal>con1</literal>
</entry>
<entry>
- Using AT clause connecting at con2
+ With <literal>AT</literal> that connects to <literal>con2</literal>
</entry>
<entry>
con1
@@ -6935,10 +6939,10 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
4
</entry>
<entry>
- Without AT clause
+ Without <literal>AT</literal>
</entry>
<entry>
- Using AT clause connecting at con2
+ With <literal>AT</literal> that connects to <literal>con2</literal>
</entry>
<entry>
con2
@@ -6948,7 +6952,7 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
</tgroup>
</table>
<para>
- In scenario 4, DECLARE STATEMENT will be ignored.
+ In scenario 4, <command>DECLARE STATEMENT</command> will be ignored.
</para>
</refsect1>
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 95f6989f51..fded8d3b4b 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -6037,14 +6037,14 @@ PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity);
<function>PQsetErrorVerbosity</function> sets the verbosity mode,
returning the connection's previous setting.
- In <firstterm>TERSE</firstterm> mode, returned messages include
+ In <literal>TERSE</literal> mode, returned messages include
severity, primary text, and position only; this will normally fit on a
- single line. The default mode produces messages that include the above
+ single line. The <literal>DEFAULT</literal> mode produces messages that include the above
plus any detail, hint, or context fields (these might span multiple
- lines). The <firstterm>VERBOSE</firstterm> mode includes all available
- fields. The <firstterm>SQLSTATE</firstterm> mode includes only the
+ lines). The <literal>VERBOSE</literal> mode includes all available
+ fields. The <literal>SQLSTATE</literal> mode includes only the
error severity and the <symbol>SQLSTATE</symbol> error code, if one is
- available (if not, the output is like <firstterm>TERSE</firstterm>
+ available (if not, the output is like <literal>TERSE</literal>
mode).
</para>
diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml
index 1972c20a8f..4f8757a6d6 100644
--- a/doc/src/sgml/maintenance.sgml
+++ b/doc/src/sgml/maintenance.sgml
@@ -871,7 +871,7 @@ analyze threshold = analyze base threshold + analyze scale factor * number of tu
<xref linkend="sql-reindex"/> can be used safely and easily in all cases.
This command requires an <literal>ACCESS EXCLUSIVE</literal> lock by
default, hence it is often preferable to execute it with its
- <literal>CONCURRENTLY</literal> option which requires only a
+ <literal>CONCURRENTLY</literal> option, which requires only a
<literal>SHARE UPDATE EXCLUSIVE</literal> lock.
</para>
</sect1>
diff --git a/doc/src/sgml/planstats.sgml b/doc/src/sgml/planstats.sgml
index a25ce152ac..b8fe405eef 100644
--- a/doc/src/sgml/planstats.sgml
+++ b/doc/src/sgml/planstats.sgml
@@ -681,8 +681,8 @@ EXPLAIN (ANALYZE, TIMING OFF) SELECT * FROM t WHERE a = 1 AND b = 10;
</programlisting>
Secondly, <acronym>MCV</acronym> lists handle a wider range of clause types,
- not just equality clauses like functional dependencies. See for example the
- example range query, presented earlier:
+ not just equality clauses like functional dependencies. For example,
+ consider the following range query for the same table:
<programlisting>
EXPLAIN (ANALYZE, TIMING OFF) SELECT * FROM t WHERE a <= 49 AND b > 49;
diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml
index c922954c64..77134c9562 100644
--- a/doc/src/sgml/ref/create_table.sgml
+++ b/doc/src/sgml/ref/create_table.sgml
@@ -2239,9 +2239,8 @@ CREATE TABLE cities_partdef
Typed tables implement a subset of the SQL standard. According to
the standard, a typed table has columns corresponding to the
underlying composite type as well as one other column that is
- the <quote>self-referencing column</quote>. PostgreSQL does not
- support these self-referencing columns explicitly, but the same
- effect can be had using the OID feature.
+ the <quote>self-referencing column</quote>. <productname>PostgreSQL</productname>
+ does not support self-referencing columns explicitly.
</para>
</refsect2>
diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml
index 1047c77a63..342a0ff7b7 100644
--- a/doc/src/sgml/storage.sgml
+++ b/doc/src/sgml/storage.sgml
@@ -957,7 +957,8 @@ data. Empty in ordinary tables.</entry>
only present if the <firstterm>HEAP_HASNULL</firstterm> bit is set in
<structfield>t_infomask</structfield>. If it is present it begins just after
the fixed header and occupies enough bytes to have one bit per data column
- (that is, <structfield>t_natts</structfield> bits altogether). In this list of bits, a
+ (that is, the number of bits that equals the attribute count in
+ <structfield>t_infomask2</structfield>). In this list of bits, a
1 bit indicates not-null, a 0 bit is a null. When the bitmap is not
present, all columns are assumed not-null.
The object ID is only present if the <firstterm>HEAP_HASOID_OLD</firstterm> bit
* Re: minor doc fixes for REL_12_STABLE
@ 2019-08-20 04:48 Michael Paquier <michael@paquier.xyz>
parent: Liudmila Mantrova <l.mantrova@gmail.com>
0 siblings, 1 reply; 5+ messages in thread
From: Michael Paquier @ 2019-08-20 04:48 UTC (permalink / raw)
To: Liudmila Mantrova <l.mantrova@gmail.com>; +Cc: pgsql-docs
On Mon, Aug 19, 2019 at 05:12:12PM +0300, Liudmila Mantrova wrote:
> Please consider the attached patches that fix some documentation
> inconsistencies in REL_12_STABLE branch. The first one contains fixes of
> typos and tagging issues that were discovered during new content
> translation. The other is a back-patch of fixes already accepted in master
> after REL_12_STABLE has been created (originally reported by Alexander
> Lakhin in "Fix typos and inconsistencies for HEAD" series).
Most of the stuff in v12-doc-fixes.patch looks pretty good. I don't
agree with some of the changes in libpq.sgml, as firstterm is used to
outline the different modes of the error verbosity API. Using
firstterm is also more consistent with ErrorContextVisibility. You
are right though that a markup for the default mode goes missing. I
have tweaked a couple of other things, and committed that part to HEAD
and REL_12_STABLE.
Now, for the second patch... First thanks for helping me with my
laziness and gather all the changes which have been done in the docs
on HEAD (Alexander has done an awesome lot of work recently and going
after each doc change was too much for me). Some of the issues are
much older than 12, so I have committed them separately with the
portions that are affected.
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: minor doc fixes for REL_12_STABLE
@ 2019-08-22 13:13 Liudmila Mantrova <l.mantrova@gmail.com>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 1 reply; 5+ messages in thread
From: Liudmila Mantrova @ 2019-08-22 13:13 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: pgsql-docs
On Tue, Aug 20, 2019 at 7:48 AM Michael Paquier <michael@paquier.xyz> wrote:
> On Mon, Aug 19, 2019 at 05:12:12PM +0300, Liudmila Mantrova wrote:
>
> Most of the stuff in v12-doc-fixes.patch looks pretty good. I don't
> agree with some of the changes in libpq.sgml, as firstterm is used to
> outline the different modes of the error verbosity API. Using
> firstterm is also more consistent with ErrorContextVisibility. You
> are right though that a markup for the default mode goes missing. I
> have tweaked a couple of other things, and committed that part to HEAD
> and REL_12_STABLE.
>
You may be right on this one for consistency reasons, but it still looks
like a mode name to me, not a new term to be explained. BTW, I believe
firstterm is usually used for each term only once, and
<firstterm>TERSE</firstterm> appears twice in a single paragraph now. Also
firstterm is a translatable element, while literal is not (and e.g. TERSE
doesn't look like something to translate in this context).
Looks like you have also changed "an SQL" to "a SQL" in some cases (but not
everywhere), and I wonder what's the official guidance here for PostgreSQL
documentation. I see no consistency, but the first version appears more
often, that's why I decided to use it (although I have to admit that I've
been looking for something to confirm my personal preference).
>
> Now, for the second patch... First thanks for helping me with my
> laziness and gather all the changes which have been done in the docs
> on HEAD (Alexander has done an awesome lot of work recently and going
> after each doc change was too much for me).
>
All the credit should go to Alexander.
Thank you for a prompt commit!
--
Best regards,
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: minor doc fixes for REL_12_STABLE
@ 2019-08-23 01:40 Michael Paquier <michael@paquier.xyz>
parent: Liudmila Mantrova <l.mantrova@gmail.com>
0 siblings, 1 reply; 5+ messages in thread
From: Michael Paquier @ 2019-08-23 01:40 UTC (permalink / raw)
To: Liudmila Mantrova <l.mantrova@gmail.com>; +Cc: pgsql-docs
On Thu, Aug 22, 2019 at 04:13:00PM +0300, Liudmila Mantrova wrote:
> Looks like you have also changed "an SQL" to "a SQL" in some cases (but not
> everywhere), and I wonder what's the official guidance here for PostgreSQL
> documentation. I see no consistency, but the first version appears more
> often, that's why I decided to use it (although I have to admit that I've
> been looking for something to confirm my personal preference).
This was discussed not long ago, and there was no actual consensus
that one was better than the other. We have that in the code tree:
$ git grep -i "a sql" | wc -l
875
$ git grep -i "an sql" | wc -l
304
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: minor doc fixes for REL_12_STABLE
@ 2019-08-23 04:21 Tom Lane <tgl@sss.pgh.pa.us>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 0 replies; 5+ messages in thread
From: Tom Lane @ 2019-08-23 04:21 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: Liudmila Mantrova <l.mantrova@gmail.com>; pgsql-docs
Michael Paquier <michael@paquier.xyz> writes:
> On Thu, Aug 22, 2019 at 04:13:00PM +0300, Liudmila Mantrova wrote:
>> Looks like you have also changed "an SQL" to "a SQL" in some cases (but not
>> everywhere), and I wonder what's the official guidance here for PostgreSQL
>> documentation.
> This was discussed not long ago, and there was no actual consensus
> that one was better than the other.
Yeah. Some people pronounce SQL as "sequel", while others say
"ess-que-ell", and then whether you say "a" or "an" depends on that.
There's no definitive right answer on the pronunciation.
It might be best to try to cast your sentences so that the issue
doesn't come up ;-)
regards, tom lane
^ permalink raw reply [nested|flat] 5+ messages in thread
end of thread, other threads:[~2019-08-23 04:21 UTC | newest]
Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2019-08-19 14:12 minor doc fixes for REL_12_STABLE Liudmila Mantrova <l.mantrova@gmail.com>
2019-08-20 04:48 ` Michael Paquier <michael@paquier.xyz>
2019-08-22 13:13 ` Liudmila Mantrova <l.mantrova@gmail.com>
2019-08-23 01:40 ` Michael Paquier <michael@paquier.xyz>
2019-08-23 04:21 ` Tom Lane <tgl@sss.pgh.pa.us>
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