From 0431a787469265776eeb9a472beb3457d2990edb Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Tue, 20 Aug 2019 12:36:31 +0900 Subject: [PATCH] Doc: Improve wording of multiple places in documentation This has been found during its translation. Author: Liudmila Mantrova Discussion: https://postgr.es/m/CAEkD-mDJHV3bhgezu3MUafJLoAKsOOT86+wHukKU8_NeiJYhLQ@mail.gmail.com Backpatch-through: 12 --- doc/src/sgml/catalogs.sgml | 20 +++++----- doc/src/sgml/client-auth.sgml | 9 +++-- doc/src/sgml/config.sgml | 29 ++++++++------- doc/src/sgml/ecpg.sgml | 60 ++++++++++++++++-------------- doc/src/sgml/libpq.sgml | 14 +++---- doc/src/sgml/maintenance.sgml | 2 +- doc/src/sgml/planstats.sgml | 4 +- doc/src/sgml/ref/create_table.sgml | 6 +-- doc/src/sgml/storage.sgml | 3 +- 9 files changed, 77 insertions(+), 70 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 68ad5071ca..5e71a2e865 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -3017,9 +3017,9 @@ SCRAM-SHA-256$<iteration count>:&l A DROP of the referenced object will result in automatically dropping the dependent object whether CASCADE 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 NORMAL and AUTO + 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 NORMAL and AUTO dependencies of the dependent object behave much like they were dependencies of the referenced object. Example: a view's ON SELECT rule is made @@ -10967,7 +10967,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx pg_stats_ext 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 pg_statistic_ext. @@ -11024,7 +11024,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx attnames name[] pg_attribute.attname - Names of the column the extended statistics is defined on + Names of the columns the extended statistics is defined on @@ -11038,9 +11038,9 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx n_distinct pg_ndistinct - 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 + 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 ANALYZE 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 anyarray - 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.) 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 database user - Note that the only supported for use + Note that the only supported + authentication methods for use with GSSAPI encryption are gss, reject, and trust. @@ -489,7 +490,7 @@ hostnogssenc database user Use GSSAPI to authenticate the user. This is only - available for TCP/IP connections . See for details. It can be used in conjunction with GSSAPI encryption. @@ -610,8 +611,8 @@ hostnogssenc database userverify-full additionally enforces that the cn (Common Name) in the certificate matches the username or an applicable mapping. - This behavior is similar to the cert authentication method - (see ) but enables pairing + This behavior is similar to the cert authentication + method (see ) but enables pairing the verification of client certificates with any authentication method that supports hostssl entries. diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index e99482d399..89284dc5c0 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -3146,29 +3146,29 @@ include_dir 'conf.d' - To start the server in standby mode create file called + To start the server in standby mode, create a file called standby.signalstandby.signal 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 primary_conninfo setting and/or by fetching new WAL - segments using restore_command. In this mode, you may + segments using restore_command. In this mode, you can use parameters in both and sections. Parameters from + linkend="runtime-config-replication-standby"/>. Parameters from will not be used. - To start the server in targeted recovery create a file called + To start the server in targeted recovery mode, create a file called recovery.signalrecovery.signal in the data directory. If both standby.signal and recovery.signal files are created, standby mode - takes precedence. Targeted recovery mode will end when end of archived - WAL is reached, or when recovery_target is reached. - In this mode you may use parameters from both recovery_target is reached. + In this mode, you can use parameters from both and sections. Parameters from . Parameters from will not be used. @@ -8032,8 +8032,9 @@ SET XML OPTION { DOCUMENT | CONTENT }; given decimal precision. The precision used is the standard number of digits for the type (FLT_DIG or DBL_DIG 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 + float4 values to be output rounded to 5 significant + digits, and float8 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. @@ -9201,10 +9202,10 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir' - Reports the name of the SSL library that this PostgreSQL server was - built with (even if SSL is not currently configured or in use on this - instance), for example OpenSSL, or an empty string - if none. + Reports the name of the SSL library that this + PostgreSQL server was built with (even if + SSL is not currently configured or in use on this instance), for + example OpenSSL, or an empty string if none. diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml index a1ebcaa862..a7d90047ed 100644 --- a/doc/src/sgml/ecpg.sgml +++ b/doc/src/sgml/ecpg.sgml @@ -312,14 +312,14 @@ current=testdb1 (should be testdb1) - The third option is to declare a sql identifier linked to + The third option is to declare a SQL identifier linked to the connection, for example: EXEC SQL AT connection-name DECLARE statement-name STATEMENT; EXEC SQL PREPARE statement-name FROM :dyn-string; - Once you link a sql identifier to a connection, you execute a dynamic SQL - without AT clause. + Once you link a SQL identifier to a connection, execute dynamic SQL + statements using this identifier without the AT clause. @@ -1209,8 +1209,8 @@ EXEC SQL END DECLARE SECTION; bytea - The handling of the bytea type is also similar to - the VARCHAR. The definition on an array of type + The handling of the bytea type is similar to + that of VARCHAR. The definition on an array of type bytea is converted into a named struct for every variable. A declaration like: @@ -1221,8 +1221,8 @@ bytea var[180]; struct bytea_var { int len; char arr[180]; } var; The member arr hosts binary format - data. It also can handle even '\0' as part of - data unlike VARCHAR. + data. It can also handle '\0' as part of + data, unlike VARCHAR. The data is converted from/to hex format and sent/received by ecpglib. @@ -6810,7 +6810,7 @@ EXEC SQL DECLARE cur1 CURSOR FOR stmt1; DECLARE STATEMENT - declares SQL statement identifier associated with connection + declares a SQL statement identifier associated with connection @@ -6823,12 +6823,13 @@ EXEC SQL [ AT connection_name ] DEC Description - DECLARE STATEMENT declares SQL statement identifier. - SQL statement identifier is associated with connection. + DECLARE STATEMENT declares a SQL statement identifier + to be associated with connection. - DECLARE CURSOR with a SQL statement identifier can be written before PREPARE. + DECLARE CURSOR with an SQL statement identifier + can be written before PREPARE. @@ -6843,7 +6844,8 @@ EXEC SQL [ AT connection_name ] DEC A database connection name established by the CONNECT command. - If AT clause is omitted, an SQL statement identifier is associated with the DEFAULT connection. + If the AT clause is omitted, the SQL statement + identifier is associated with the DEFAULT connection. @@ -6854,7 +6856,8 @@ EXEC SQL [ AT connection_name ] DEC statement_name - 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. @@ -6864,9 +6867,10 @@ EXEC SQL [ AT connection_name ] DEC Notes - 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 AT clause can be used with both + DECLARE STATEMENT and other dynamic SQL statements. + The following table illustrates how it affects the selected database + connection. Scenario @@ -6874,16 +6878,16 @@ EXEC SQL [ AT connection_name ] DEC - Using Scenario + Usage Scenario - Declare Statement + DECLARE STATEMENT Other Dynamic Statements - Executed Database + Target Database @@ -6893,10 +6897,10 @@ EXEC SQL [ AT connection_name ] DEC 1 - Without AT clause + Without AT - Without AT clause + Without AT Default connection @@ -6907,10 +6911,10 @@ EXEC SQL [ AT connection_name ] DEC 2 - Using AT clause connecting at con1 + With AT that connects to con1 - Without AT clause + Without AT con1 @@ -6921,10 +6925,10 @@ EXEC SQL [ AT connection_name ] DEC 3 - Using AT clause connecting at con1 + With AT that connects to con1 - Using AT clause connecting at con2 + With AT that connects to con2 con1 @@ -6935,10 +6939,10 @@ EXEC SQL [ AT connection_name ] DEC 4 - Without AT clause + Without AT - Using AT clause connecting at con2 + With AT that connects to con2 con2 @@ -6948,7 +6952,7 @@ EXEC SQL [ AT connection_name ] DEC
- In scenario 4, DECLARE STATEMENT will be ignored. + In scenario 4, DECLARE STATEMENT will be ignored. diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index e7295abda2..b7c3d96b01 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -5620,13 +5620,13 @@ PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity); returning the connection's previous setting. In TERSE 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 - plus any detail, hint, or context fields (these might span multiple - lines). The VERBOSE mode includes all available - fields. The SQLSTATE mode includes only the - error severity and the SQLSTATE error code, if one is - available (if not, the output is like TERSE - mode). + single line. The DEFAULT mode produces messages + that include the above plus any detail, hint, or context fields (these + might span multiple lines). The VERBOSE mode + includes all available fields. The SQLSTATE + mode includes only the error severity and the SQLSTATE + error code, if one is available (if not, the output is like + TERSE mode). 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 can be used safely and easily in all cases. This command requires an ACCESS EXCLUSIVE lock by default, hence it is often preferable to execute it with its - CONCURRENTLY option which requires only a + CONCURRENTLY option, which requires only a SHARE UPDATE EXCLUSIVE lock. 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; Secondly, MCV 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: 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..a2a44b3fc0 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -2239,9 +2239,9 @@ 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 self-referencing column. PostgreSQL does not - support these self-referencing columns explicitly, but the same - effect can be had using the OID feature. + the self-referencing column. + PostgreSQL does not support self-referencing + columns explicitly. 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. only present if the HEAP_HASNULL bit is set in t_infomask. If it is present it begins just after the fixed header and occupies enough bytes to have one bit per data column - (that is, t_natts bits altogether). In this list of bits, a + (that is, the number of bits that equals the attribute count in + t_infomask2). 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 HEAP_HASOID_OLD bit -- 2.40.0