From 3fb67ac9c65b31ae179a80662b6bed0b00bba248 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Mon, 31 Aug 2020 18:33:37 -0400 Subject: [PATCH] doc: add commas after 'i.e.' and 'e.g.' This follows the American format, https://jakubmarian.com/comma-after-i-e-and-e-g/. There is no intention of requiring this format for future text, but making existing text consistent every few years makes sense. Discussion: https://postgr.es/m/20200825183619.GA22369@momjian.us Backpatch-through: 9.5 --- doc/src/sgml/bki.sgml | 2 +- doc/src/sgml/config.sgml | 16 +++++++-------- doc/src/sgml/datatype.sgml | 4 ++-- doc/src/sgml/ddl.sgml | 4 ++-- doc/src/sgml/ecpg.sgml | 6 +++--- doc/src/sgml/extend.sgml | 4 ++-- doc/src/sgml/func.sgml | 10 ++++----- doc/src/sgml/high-availability.sgml | 8 ++++---- doc/src/sgml/indexam.sgml | 2 +- doc/src/sgml/install-windows.sgml | 4 ++-- doc/src/sgml/libpq.sgml | 16 +++++++-------- doc/src/sgml/monitoring.sgml | 2 +- doc/src/sgml/mvcc.sgml | 2 +- doc/src/sgml/parallel.sgml | 4 ++-- doc/src/sgml/perform.sgml | 2 +- doc/src/sgml/protocol.sgml | 4 ++-- doc/src/sgml/queries.sgml | 4 ++-- doc/src/sgml/ref/create_database.sgml | 4 ++-- doc/src/sgml/ref/create_event_trigger.sgml | 2 +- doc/src/sgml/ref/create_function.sgml | 6 +++--- doc/src/sgml/ref/create_procedure.sgml | 2 +- doc/src/sgml/ref/create_statistics.sgml | 2 +- doc/src/sgml/ref/create_table.sgml | 4 ++-- doc/src/sgml/ref/initdb.sgml | 2 +- doc/src/sgml/ref/pg_dump.sgml | 2 +- doc/src/sgml/ref/pg_dumpall.sgml | 2 +- doc/src/sgml/ref/pg_restore.sgml | 2 +- doc/src/sgml/ref/pg_rewind.sgml | 2 +- doc/src/sgml/ref/pgbench.sgml | 10 ++++----- doc/src/sgml/ref/pgupgrade.sgml | 24 +++++++++++----------- doc/src/sgml/ref/postgres-ref.sgml | 2 +- doc/src/sgml/ref/prepare.sgml | 2 +- doc/src/sgml/ref/psql-ref.sgml | 6 +++--- doc/src/sgml/replication-origins.sgml | 6 +++--- doc/src/sgml/runtime.sgml | 2 +- doc/src/sgml/sepgsql.sgml | 2 +- doc/src/sgml/sources.sgml | 4 ++-- doc/src/sgml/sslinfo.sgml | 4 ++-- doc/src/sgml/tableam.sgml | 2 +- doc/src/sgml/textsearch.sgml | 4 ++-- doc/src/sgml/wal.sgml | 2 +- doc/src/sgml/xfunc.sgml | 6 +++--- doc/src/sgml/xml2.sgml | 2 +- 43 files changed, 101 insertions(+), 101 deletions(-) diff --git a/doc/src/sgml/bki.sgml b/doc/src/sgml/bki.sgml index cf2e11f6aab..4eb89bd8b90 100644 --- a/doc/src/sgml/bki.sgml +++ b/doc/src/sgml/bki.sgml @@ -458,7 +458,7 @@ Use of symbolic references is enabled in a particular catalog column by attaching BKI_LOOKUP(lookuprule) to the column's definition, where lookuprule - is the name of the referenced catalog, e.g. pg_proc. + is the name of the referenced catalog, e.g., pg_proc. BKI_LOOKUP can be attached to columns of type Oid, regproc, oidvector, or Oid[]; in the latter two cases it implies performing a diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 659234096a2..fb48a5fcd03 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -424,7 +424,7 @@ include_dir 'directory' start with the . character are also ignored, to prevent mistakes since such files are hidden on some platforms. Multiple files within an include directory are processed in file name order - (according to C locale rules, i.e. numbers before letters, and + (according to C locale rules, i.e., numbers before letters, and uppercase letters before lowercase ones). @@ -1090,7 +1090,7 @@ include_dir 'conf.d' With this parameter enabled, you can still create ordinary global users. Simply append @ when specifying the user - name in the client, e.g. joe@. The @ + name in the client, e.g., joe@. The @ will be stripped off before the user name is looked up by the server. @@ -3168,7 +3168,7 @@ include_dir 'conf.d' disabled, but the server continues to accumulate WAL segment files in the expectation that a command will soon be provided. Setting archive_command to a command that does nothing but - return true, e.g. /bin/true (REM on + return true, e.g., /bin/true (REM on Windows), effectively disables archiving, but also breaks the chain of WAL files needed for archive recovery, so it should only be used in unusual circumstances. @@ -3413,7 +3413,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows This parameter specifies that recovery should end as soon as a - consistent state is reached, i.e. as early as possible. When restoring + consistent state is reached, i.e., as early as possible. When restoring from an online backup, this means the point where taking the backup ended. @@ -3459,7 +3459,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows variable has been set earlier in the configuration file). Preferred style is to use a numeric offset from UTC, or you can write a full time zone name, - e.g. Europe/Helsinki not EEST. + e.g., Europe/Helsinki not EEST. @@ -4766,7 +4766,7 @@ ANY num_sync ( for more information. @@ -1466,7 +1466,7 @@ include $(PGXS) NO_INSTALLCHECK - don't define an installcheck target, useful e.g. if tests require special configuration, or don't use pg_regress + don't define an installcheck target, useful e.g., if tests require special configuration, or don't use pg_regress diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index cd1c4ebd764..dcda4525102 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -6685,9 +6685,9 @@ SELECT regexp_match('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}'); In to_timestamp and to_date, - if the year format specification is less than four digits, e.g. + if the year format specification is less than four digits, e.g., YYY, and the supplied year is less than four digits, - the year will be adjusted to be nearest to the year 2020, e.g. + the year will be adjusted to be nearest to the year 2020, e.g., 95 becomes 1995. @@ -10173,7 +10173,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple "string" (to include all string values), "numeric" (to include all numeric values in the string format), "boolean" (to include all Boolean values in the string format "true"/"false"), "key" (to include all keys) or "all" (to include all above). These values - can be combined together to include, e.g. all string and numeric values. + can be combined together to include, e.g., all string and numeric values. json_to_tsvector('english', '{"a": "The Fat Rats", "b": 123}'::json, '["string", "numeric"]') '123':5 'fat':2 'rat':3 @@ -22374,7 +22374,7 @@ FOR EACH ROW EXECUTE FUNCTION suppress_redundant_updates_trigger(); objsubid integer - Sub-object ID (e.g. attribute number for a column) + Sub-object ID (e.g., attribute number for a column) command_tag @@ -22461,7 +22461,7 @@ FOR EACH ROW EXECUTE FUNCTION suppress_redundant_updates_trigger(); objsubid integer - Sub-object ID (e.g. attribute number for a column) + Sub-object ID (e.g., attribute number for a column) original diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml index 01eff5012c2..f133fb388a2 100644 --- a/doc/src/sgml/high-availability.sgml +++ b/doc/src/sgml/high-availability.sgml @@ -219,7 +219,7 @@ protocol to make nodes agree on a serializable transactional order. this is unacceptable, either the middleware or the application must query such values from a single server and then use those values in write queries. Another option is to use this replication - option with a traditional master-standby setup, i.e. data modification + option with a traditional master-standby setup, i.e., data modification queries are sent only to the master and are propagated to the standby servers via master-standby replication, not by the replication middleware. Care must also be taken that all @@ -657,7 +657,7 @@ protocol to make nodes agree on a serializable transactional order. Set up continuous archiving on the primary to an archive directory accessible from the standby, as described in . The archive location should be - accessible from the standby even when the master is down, i.e. it should + accessible from the standby even when the master is down, i.e., it should reside on the standby server itself or another trusted server, not on the master server. @@ -2222,7 +2222,7 @@ LOG: database system is ready to accept read only connections - Data Definition Language (DDL) - e.g. CREATE INDEX + Data Definition Language (DDL) - e.g., CREATE INDEX @@ -2288,7 +2288,7 @@ LOG: database system is ready to accept read only connections WAL file control commands will not work during recovery, - e.g. pg_start_backup, pg_switch_wal etc. + e.g., pg_start_backup, pg_switch_wal etc. diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml index dd54c688024..85518f6e795 100644 --- a/doc/src/sgml/indexam.sgml +++ b/doc/src/sgml/indexam.sgml @@ -379,7 +379,7 @@ amcanreturn (Relation indexRelation, int attno); linkend="indexes-index-only-scans">index-only scans on the given column, by returning the indexed column values for an index entry in the form of an IndexTuple. The attribute number - is 1-based, i.e. the first column's attno is 1. Returns true if supported, + is 1-based, i.e., the first column's attno is 1. Returns true if supported, else false. If the access method does not support index-only scans at all, the amcanreturn field in its IndexAmRoutine struct can be set to NULL. diff --git a/doc/src/sgml/install-windows.sgml b/doc/src/sgml/install-windows.sgml index bb76b04d32b..93f02a30431 100644 --- a/doc/src/sgml/install-windows.sgml +++ b/doc/src/sgml/install-windows.sgml @@ -118,7 +118,7 @@ same purpose. From the Visual Studio Command Prompt, you can change the targeted CPU architecture, build type, and target OS by using the - vcvarsall.bat command, e.g. + vcvarsall.bat command, e.g., vcvarsall.bat x64 10.0.10240.0 to target Windows 10 with a 64-bit release build. See -help for the other options of vcvarsall.bat. All commands should be run from @@ -251,7 +251,7 @@ $ENV{MSBFLAGS}="/m"; installations C:\Program Files\GnuWin32. Consider installing into C:\GnuWin32 or use the NTFS short name path to GnuWin32 in your PATH environment setting - (e.g. C:\PROGRA~1\GnuWin32). + (e.g., C:\PROGRA~1\GnuWin32). diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index c443cc87d1d..e2e1e80923a 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -355,7 +355,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); Conversely, if PQconnectPoll(conn) last returned PGRES_POLLING_WRITING, wait until the socket is ready to write, then call PQconnectPoll(conn) again. - On the first iteration, i.e. if you have yet to call + On the first iteration, i.e., if you have yet to call PQconnectPoll, behave as if it last returned PGRES_POLLING_WRITING. Continue this loop until PQconnectPoll(conn) returns @@ -860,7 +860,7 @@ postgresql:///mydb?host=localhost&port=5433 Percent-encoding may be used to include symbols with special meaning in any - of the URI parts, e.g. replace = with + of the URI parts, e.g., replace = with %3D. @@ -919,7 +919,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname hostaddr, and port options accept a comma-separated list of values. The same number of elements must be given in each option that is specified, such - that e.g. the first hostaddr corresponds to the first host name, + that e.g., the first hostaddr corresponds to the first host name, the second hostaddr corresponds to the second host name, and so forth. As an exception, if only one port is specified, it applies to all the hosts. @@ -947,7 +947,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname If a password file is used, you can have different passwords for different hosts. All the other connection options are the same for every - host in the list; it is not possible to e.g. specify different + host in the list; it is not possible to e.g., specify different usernames for different hosts. @@ -1123,7 +1123,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname Maximum wait for connection, in seconds (write as a decimal integer, - e.g. 10). Zero, negative, or not specified means + e.g., 10). Zero, negative, or not specified means wait indefinitely. The minimum allowed timeout is 2 seconds, therefore a value of 1 is interpreted as 2. This timeout applies separately to each host name or IP address. @@ -2332,7 +2332,7 @@ const char *PQsslAttribute(const PGconn *conn, const char *attribute_name); cipher - A short name of the ciphersuite used, e.g. + A short name of the ciphersuite used, e.g., "DHE-RSA-DES-CBC3-SHA". The names are specific to each SSL implementation. @@ -4981,7 +4981,7 @@ int PQflush(PGconn *conn); PQflush again. Repeat until PQflush returns 0. (It is necessary to check for read-ready and drain the input with PQconsumeInput, - because the server can block trying to send us data, e.g. NOTICE + because the server can block trying to send us data, e.g., NOTICE messages, and won't read our data until we read its.) Once PQflush returns 0, wait for the socket to be read-ready and then read the response as described above. @@ -8049,7 +8049,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*) For a connection to be known SSL-secured, SSL usage must be configured on both the client and the server before the connection is made. If it is only configured on the server, the client may end up - sending sensitive information (e.g. passwords) before + sending sensitive information (e.g., passwords) before it knows that the server requires high security. In libpq, secure connections can be ensured by setting the sslmode parameter to verify-full or diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 82097d29b40..c95bbb9e5a7 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -206,7 +206,7 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser When the server shuts down cleanly, a permanent copy of the statistics data is stored in the pg_stat subdirectory, so that statistics can be retained across server restarts. When recovery is - performed at server start (e.g. after immediate shutdown, server crash, + performed at server start (e.g., after immediate shutdown, server crash, and point-in-time recovery), all statistics counters are reset. diff --git a/doc/src/sgml/mvcc.sgml b/doc/src/sgml/mvcc.sgml index 8f192af4607..1567180b0de 100644 --- a/doc/src/sgml/mvcc.sgml +++ b/doc/src/sgml/mvcc.sgml @@ -269,7 +269,7 @@ In PostgreSQL, you can request any of the four standard transaction isolation levels, but internally only - three distinct isolation levels are implemented, i.e. PostgreSQL's + three distinct isolation levels are implemented, i.e., PostgreSQL's Read Uncommitted mode behaves like Read Committed. This is because it is the only sensible way to map the standard isolation levels to PostgreSQL's multiversion concurrency control architecture. diff --git a/doc/src/sgml/parallel.sgml b/doc/src/sgml/parallel.sgml index 95306287e20..41b9d0d6ac2 100644 --- a/doc/src/sgml/parallel.sgml +++ b/doc/src/sgml/parallel.sgml @@ -433,7 +433,7 @@ EXPLAIN SELECT * FROM pgbench_accounts WHERE filler LIKE '%x%'; . Of course, this plan may turn out to be slower than the serial plan which the planner preferred, but this will not always be the case. If you don't get a parallel - plan even with very small values of these settings (e.g. after setting + plan even with very small values of these settings (e.g., after setting them both to zero), there may be some reason why the query planner is unable to generate a parallel plan for your query. See and @@ -531,7 +531,7 @@ EXPLAIN SELECT * FROM pgbench_accounts WHERE filler LIKE '%x%'; Functions and aggregates must be marked PARALLEL UNSAFE if they write to the database, access sequences, change the transaction state - even temporarily (e.g. a PL/pgSQL function which establishes an + even temporarily (e.g., a PL/pgSQL function which establishes an EXCEPTION block to catch errors), or make persistent changes to settings. Similarly, functions must be marked PARALLEL RESTRICTED if they access temporary tables, client connection state, diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml index 0f61b0995d3..8ee340f67d7 100644 --- a/doc/src/sgml/perform.sgml +++ b/doc/src/sgml/perform.sgml @@ -1891,7 +1891,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse; Place the database cluster's data directory in a memory-backed - file system (i.e. RAM disk). This eliminates all + file system (i.e., RAM disk). This eliminates all database disk I/O, but limits data storage to the amount of available memory (and perhaps swap). diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 15e84154823..b3c21296449 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -28,7 +28,7 @@ the server, the connection will be rejected (for example, this would occur if the client requested protocol version 4.0, which does not exist as of this writing). If the minor version requested by the client is not - supported by the server (e.g. the client requests version 3.1, but the + supported by the server (e.g., the client requests version 3.1, but the server supports only 3.0), the server may either reject the connection or may respond with a NegotiateProtocolVersion message containing the highest minor protocol version which it supports. The client may then choose either @@ -422,7 +422,7 @@ by the client, but does support an earlier version of the protocol; this message indicates the highest supported minor version. This message will also be sent if the client requested unsupported protocol - options (i.e. beginning with _pq_.) in the + options (i.e., beginning with _pq_.) in the startup packet. This message will be followed by an ErrorResponse or a message indicating the success or failure of authentication. diff --git a/doc/src/sgml/queries.sgml b/doc/src/sgml/queries.sgml index 22252556be2..56539c9fdd9 100644 --- a/doc/src/sgml/queries.sgml +++ b/doc/src/sgml/queries.sgml @@ -1256,7 +1256,7 @@ GROUPING SETS ( ( ) ) - This is commonly used for analysis over hierarchical data; e.g. total + This is commonly used for analysis over hierarchical data; e.g., total salary by department, division, and company-wide total. @@ -1265,7 +1265,7 @@ GROUPING SETS ( CUBE ( e1, e2, ... ) - represents the given list and all of its possible subsets (i.e. the power + represents the given list and all of its possible subsets (i.e., the power set). Thus CUBE ( a, b, c ) diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index a3b2e98b467..88e93ea2a15 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -116,7 +116,7 @@ CREATE DATABASE name Collation order (LC_COLLATE) to use in the new database. - This affects the sort order applied to strings, e.g. in queries with + This affects the sort order applied to strings, e.g., in queries with ORDER BY, as well as the order used in indexes on text columns. The default is to use the collation order of the template database. See below for additional restrictions. @@ -128,7 +128,7 @@ CREATE DATABASE name Character classification (LC_CTYPE) to use in the new - database. This affects the categorization of characters, e.g. lower, + database. This affects the categorization of characters, e.g., lower, upper and digit. The default is to use the character classification of the template database. See below for additional restrictions. diff --git a/doc/src/sgml/ref/create_event_trigger.sgml b/doc/src/sgml/ref/create_event_trigger.sgml index 52ba746166b..becd31bcadf 100644 --- a/doc/src/sgml/ref/create_event_trigger.sgml +++ b/doc/src/sgml/ref/create_event_trigger.sgml @@ -86,7 +86,7 @@ CREATE EVENT TRIGGER name A list of values for the associated filter_variable for which the trigger should fire. For TAG, this means a - list of command tags (e.g. 'DROP FUNCTION'). + list of command tags (e.g., 'DROP FUNCTION'). diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index f81cedc8233..97285b75784 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -257,7 +257,7 @@ CREATE [ OR REPLACE ] FUNCTION The name of the language that the function is implemented in. It can be sql, c, internal, or the name of a user-defined - procedural language, e.g. plpgsql. Enclosing the + procedural language, e.g., plpgsql. Enclosing the name in single quotes is deprecated and requires matching case. @@ -431,11 +431,11 @@ CREATE [ OR REPLACE ] FUNCTION Functions should be labeled parallel unsafe if they modify any database state, or if they make changes to the transaction such as using sub-transactions, or if they access sequences or attempt to make - persistent changes to settings (e.g. setval). They should + persistent changes to settings (e.g., setval). They should be labeled as parallel restricted if they access temporary tables, client connection state, cursors, prepared statements, or miscellaneous backend-local state which the system cannot synchronize in parallel mode - (e.g. setseed cannot be executed other than by the group + (e.g., setseed cannot be executed other than by the group leader because a change made by another process would not be reflected in the leader). In general, if a function is labeled as being safe when it is restricted or unsafe, or if it is labeled as being restricted when diff --git a/doc/src/sgml/ref/create_procedure.sgml b/doc/src/sgml/ref/create_procedure.sgml index 0ea6513cb58..d225695626c 100644 --- a/doc/src/sgml/ref/create_procedure.sgml +++ b/doc/src/sgml/ref/create_procedure.sgml @@ -164,7 +164,7 @@ CREATE [ OR REPLACE ] PROCEDURE The name of the language that the procedure is implemented in. It can be sql, c, internal, or the name of a user-defined - procedural language, e.g. plpgsql. Enclosing the + procedural language, e.g., plpgsql. Enclosing the name in single quotes is deprecated and requires matching case. diff --git a/doc/src/sgml/ref/create_statistics.sgml b/doc/src/sgml/ref/create_statistics.sgml index 5b583aacb43..4363be50c3c 100644 --- a/doc/src/sgml/ref/create_statistics.sgml +++ b/doc/src/sgml/ref/create_statistics.sgml @@ -131,7 +131,7 @@ CREATE STATISTICS [ IF NOT EXISTS ] statistics_na Examples - Create table t1 with two functionally dependent columns, i.e. + Create table t1 with two functionally dependent columns, i.e., knowledge of a value in the first column is sufficient for determining the value in the other column. Then functional dependency statistics are built on those columns: diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index d6f9f21c2bf..63ea024b0c0 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -903,7 +903,7 @@ WITH ( MODULUS numeric_literal, REM one or more columns on which the uniqueness is not enforced. Note that although the constraint is not enforced on the included columns, it still depends on them. Consequently, some operations on these columns - (e.g. DROP COLUMN) can cause cascaded constraint and + (e.g., DROP COLUMN) can cause cascaded constraint and index deletion. @@ -949,7 +949,7 @@ WITH ( MODULUS numeric_literal, REM of columns to be specified which will be included in the non-key portion of the index. Although uniqueness is not enforced on the included columns, the constraint still depends on them. Consequently, some operations on the - included columns (e.g. DROP COLUMN) can cause cascaded + included columns (e.g., DROP COLUMN) can cause cascaded constraint and index deletion. diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index a04a1801650..af76dbede48 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -88,7 +88,7 @@ PostgreSQL documentation initdb initializes the database cluster's default locale and character set encoding. The character set encoding, collation order (LC_COLLATE) and character set classes - (LC_CTYPE, e.g. upper, lower, digit) can be set separately + (LC_CTYPE, e.g., upper, lower, digit) can be set separately for a database when it is created. initdb determines those settings for the template1 database, which will serve as the default for all other databases. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 13bd320b313..6dfc9e23b1a 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -760,7 +760,7 @@ PostgreSQL documentation - Use conditional commands (i.e. add an IF EXISTS + Use conditional commands (i.e., add an IF EXISTS clause) when cleaning database objects. This option is not valid unless is also specified. diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index f0859896c54..4eec13237ae 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -323,7 +323,7 @@ PostgreSQL documentation - Use conditional commands (i.e. add an IF EXISTS + Use conditional commands (i.e., add an IF EXISTS clause) to drop databases and other objects. This option is not valid unless is also specified. diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index b60207d05b0..d724e45f8b0 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -572,7 +572,7 @@ PostgreSQL documentation - Use conditional commands (i.e. add an IF EXISTS + Use conditional commands (i.e., add an IF EXISTS clause) to drop database objects. This option is not valid unless is also specified. diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml index 76a0c7327ad..304b58e25ca 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -71,7 +71,7 @@ PostgreSQL documentation copied from the WAL archive to the pg_wal directory, or fetched on startup by configuring or . The use of - pg_rewind is not limited to failover, e.g. a standby + pg_rewind is not limited to failover, e.g., a standby server can be promoted, run some write transactions, and then rewinded to become a standby again. diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index 26774e1d25a..b32b962a606 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -568,7 +568,7 @@ pgbench options d transaction to finish. The wait time is called the schedule lag time, and its average and maximum are also reported separately. The transaction latency with respect to the actual transaction start time, - i.e. the time spent executing the transaction in the database, can be + i.e., the time spent executing the transaction in the database, can be computed by subtracting the schedule lag time from the reported latency. @@ -718,7 +718,7 @@ pgbench options d client per thread and there are no external or data dependencies. From a statistical viewpoint reproducing runs exactly is a bad idea because it can hide the performance variability or improve performance unduly, - e.g. by hitting the same pages as a previous run. + e.g., by hitting the same pages as a previous run. However, it may also be of great help for debugging, for instance re-running a tricky case which leads to an error. Use wisely. @@ -738,7 +738,7 @@ pgbench options d Remember to take the sampling rate into account when processing the log file. For example, when computing TPS values, you need to multiply - the numbers accordingly (e.g. with 0.01 sample rate, you'll only get + the numbers accordingly (e.g., with 0.01 sample rate, you'll only get 1/100 of the actual TPS). @@ -1567,7 +1567,7 @@ f(x) = PHI(2.0 * parameter * (x - mu) / (max - min + 1)) / 2.0 / parameter, that is a relative 1.0 / parameter around the mean; for instance, if parameter is 4.0, 67% of values are drawn from the - middle quarter (1.0 / 4.0) of the interval (i.e. from + middle quarter (1.0 / 4.0) of the interval (i.e., from 3.0 / 8.0 to 5.0 / 8.0) and 95% from the middle half (2.0 / 4.0) of the interval (second and third quartiles). The minimum allowed parameter @@ -1762,7 +1762,7 @@ END; and max_lag, are only present if the option is used. They provide statistics about the time each transaction had to wait for the - previous one to finish, i.e. the difference between each transaction's + previous one to finish, i.e., the difference between each transaction's scheduled start time and the time it actually started. The very last field, skipped, is only present if the option is used, too. diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index 63cb5cbc67c..361374274d6 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -41,8 +41,8 @@ PostgreSQL documentation pg_upgrade (formerly called pg_migrator) allows data stored in PostgreSQL data files to be upgraded to a later PostgreSQL major version without the data dump/reload typically required for - major version upgrades, e.g. from 9.5.8 to 9.6.4 or from 10.7 to 11.2. - It is not required for minor version upgrades, e.g. from 9.6.2 to 9.6.3 + major version upgrades, e.g., from 9.5.8 to 9.6.4 or from 10.7 to 11.2. + It is not required for minor version upgrades, e.g., from 9.6.2 to 9.6.3 or from 10.1 to 10.2. @@ -60,7 +60,7 @@ PostgreSQL documentation pg_upgrade does its best to - make sure the old and new clusters are binary-compatible, e.g. by + make sure the old and new clusters are binary-compatible, e.g., by checking for compatible compile-time settings, including 32/64-bit binaries. It is important that any external modules are also binary compatible, though this cannot @@ -238,13 +238,13 @@ PostgreSQL documentation Optionally move the old cluster - If you are using a version-specific installation directory, e.g. + If you are using a version-specific installation directory, e.g., /opt/PostgreSQL/&majorversion;, you do not need to move the old cluster. The graphical installers all use version-specific installation directories. - If your installation directory is not version-specific, e.g. + If your installation directory is not version-specific, e.g., /usr/local/pgsql, it is necessary to move the current PostgreSQL install directory so it does not interfere with the new PostgreSQL installation. Once the current PostgreSQL server is shut down, it is safe to rename the @@ -302,9 +302,9 @@ make prefix=/usr/local/pgsql.new install Install any custom shared object files (or DLLs) used by the old cluster - into the new cluster, e.g. pgcrypto.so, + into the new cluster, e.g., pgcrypto.so, whether they are from contrib - or some other source. Do not install the schema definitions, e.g. + or some other source. Do not install the schema definitions, e.g., CREATE EXTENSION pgcrypto, because these will be upgraded from the old cluster. Also, any custom full text search files (dictionary, synonym, @@ -515,7 +515,7 @@ pg_upgrade.exe Save any configuration files from the old standbys' configuration - directories you need to keep, e.g. postgresql.conf + directories you need to keep, e.g., postgresql.conf (and any files included by it), postgresql.auto.conf, pg_hba.conf, because these will be overwritten or removed in the next step. @@ -542,7 +542,7 @@ rsync --archive --delete --hard-links --size-only --no-inc-recursive old_cluster on the standby. The directory structure under the specified directories on the primary and standbys must match. Consult the rsync manual page for details on specifying the - remote directory, e.g. + remote directory, e.g., rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/9.5 \ @@ -668,7 +668,7 @@ psql --username=postgres --file=script.sql postgres pg_upgrade completes. (Automatic deletion is not possible if you have user-defined tablespaces inside the old data directory.) You can also delete the old installation directories - (e.g. bin, share). + (e.g., bin, share). @@ -786,7 +786,7 @@ psql --username=postgres --file=script.sql postgres If you are upgrading a pre-PostgreSQL 9.2 cluster that uses a configuration-file-only directory, you must pass the real data directory location to pg_upgrade, and - pass the configuration directory location to the server, e.g. + pass the configuration directory location to the server, e.g., -d /real-data-directory -o '-D /configuration-directory'. @@ -808,7 +808,7 @@ psql --username=postgres --file=script.sql postgres copy with any changes to make it consistent. ( is necessary because rsync only has file modification-time granularity of one second.) You might want to exclude some - files, e.g. postmaster.pid, as documented in postmaster.pid, as documented in . If your file system supports file system snapshots or copy-on-write file copies, you can use that to make a backup of the old cluster and tablespaces, though the snapshot diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 1a4b7c7825d..394dd266996 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -822,7 +822,7 @@ PostgreSQL documentation To start postgres with a specific - port, e.g. 1234: + port, e.g., 1234: $ postgres -p 1234 diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml index 4e5e96a4014..aeecb08ccfa 100644 --- a/doc/src/sgml/ref/prepare.sgml +++ b/doc/src/sgml/ref/prepare.sgml @@ -73,7 +73,7 @@ PREPARE name [ ( psql returns 0 to the shell if it - finished normally, 1 if a fatal error of its own occurs (e.g. out of memory, + finished normally, 1 if a fatal error of its own occurs (e.g., out of memory, file not found), 2 if the connection to the server went bad and the session was not interactive, and 3 if an error occurred in a script and the variable ON_ERROR_STOP was set. @@ -2888,7 +2888,7 @@ lo_import 152801 In latex-longtable format, this controls the proportional width of each column containing a left-aligned data type. It is specified as a whitespace-separated list of values, - e.g. '0.2 0.2 0.6'. Unspecified output columns + e.g., '0.2 0.2 0.6'. Unspecified output columns use the last specified value. @@ -4330,7 +4330,7 @@ testdb=> \set PROMPT1 '%[%033[1;33;40m%]%n@%/%R%[%033[0m%]%# ' psql starts up. Tab-completion is also supported, although the completion logic makes no claim to be an SQL parser. The queries generated by tab-completion - can also interfere with other SQL commands, e.g. SET + can also interfere with other SQL commands, e.g., SET TRANSACTION ISOLATION LEVEL. If for some reason you do not like the tab completion, you can turn it off by putting this in a file named diff --git a/doc/src/sgml/replication-origins.sgml b/doc/src/sgml/replication-origins.sgml index a03ce76e2ef..7e02c4605b2 100644 --- a/doc/src/sgml/replication-origins.sgml +++ b/doc/src/sgml/replication-origins.sgml @@ -31,7 +31,7 @@ which is what should be used to refer to the origin across systems, is free-form text. It should be used in a way that makes conflicts between replication origins created by different replication solutions - unlikely; e.g. by prefixing the replication solution's name to it. + unlikely; e.g., by prefixing the replication solution's name to it. The OID is used only to avoid having to store the long version in situations where space efficiency is important. It should never be shared across systems. @@ -68,7 +68,7 @@ manner. Replay progress for all replication origins can be seen in the pg_replication_origin_status - view. An individual origin's progress, e.g. when resuming + view. An individual origin's progress, e.g., when resuming replication, can be acquired using pg_replication_origin_progress() for any origin or @@ -86,7 +86,7 @@ output plugin callbacks (see ) generated by the session is tagged with the replication origin of the generating session. This allows treating them differently in the output - plugin, e.g. ignoring all but locally-originating rows. Additionally + plugin, e.g., ignoring all but locally-originating rows. Additionally the filter_by_origin_cb callback can be used to filter the logical decoding change stream based on the diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 6801a1aecce..4aabfe5a404 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -1996,7 +1996,7 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433 be migrated in-place from one major PostgreSQL version to another. Upgrades can be performed in minutes, particularly with mode. It requires steps similar to - pg_dumpall above, e.g. starting/stopping the server, + pg_dumpall above, e.g., starting/stopping the server, running initdb. The pg_upgrade documentation outlines the necessary steps. diff --git a/doc/src/sgml/sepgsql.sgml b/doc/src/sgml/sepgsql.sgml index f8c99e1b002..64cde0adb56 100644 --- a/doc/src/sgml/sepgsql.sgml +++ b/doc/src/sgml/sepgsql.sgml @@ -527,7 +527,7 @@ UPDATE t1 SET x = 2, y = func1(y) WHERE z = 100; commands. SELinux provides a feature to allow trusted code to run using a security label different from that of the client, generally for the purpose of providing highly controlled access to - sensitive data (e.g. rows might be omitted, or the precision of stored + sensitive data (e.g., rows might be omitted, or the precision of stored values might be reduced). Whether or not a function acts as a trusted procedure is controlled by its security label and the operating system security policy. For example: diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index 730430c8641..ed448a3785f 100644 --- a/doc/src/sgml/sources.sgml +++ b/doc/src/sgml/sources.sgml @@ -913,7 +913,7 @@ BETTER: unrecognized node type: 42 Both, macros with arguments and static inline functions, may be used. The latter are preferable if there are - multiple-evaluation hazards when written as a macro, as e.g. the + multiple-evaluation hazards when written as a macro, as e.g., the case with #define Max(x, y) ((x) > (y) ? (x) : (y)) @@ -924,7 +924,7 @@ BETTER: unrecognized node type: 42 When the definition of an inline function references symbols - (i.e. variables, functions) that are only available as part of the + (i.e., variables, functions) that are only available as part of the backend, the function may not be visible when included from frontend code. diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml index 78ff83d6422..e5d7cff97aa 100644 --- a/doc/src/sgml/sslinfo.sgml +++ b/doc/src/sgml/sslinfo.sgml @@ -52,7 +52,7 @@ - Returns the name of the protocol used for the SSL connection (e.g. TLSv1.0 + Returns the name of the protocol used for the SSL connection (e.g., TLSv1.0 TLSv1.1, or TLSv1.2). @@ -68,7 +68,7 @@ Returns the name of the cipher used for the SSL connection - (e.g. DHE-RSA-AES256-SHA). + (e.g., DHE-RSA-AES256-SHA). diff --git a/doc/src/sgml/tableam.sgml b/doc/src/sgml/tableam.sgml index efd141d3f5c..a4fed6ea577 100644 --- a/doc/src/sgml/tableam.sgml +++ b/doc/src/sgml/tableam.sgml @@ -77,7 +77,7 @@ necessary for each tuple to have a tuple identifier (TID) consisting of a block number and an item number (see also ). It is not strictly necessary that the - sub-parts of TIDs have the same meaning they e.g. have + sub-parts of TIDs have the same meaning they e.g., have for heap, but if bitmap scan support is desired (it is optional), the block number needs to provide locality. diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml index 64d079742cb..15bac0dfdad 100644 --- a/doc/src/sgml/textsearch.sgml +++ b/doc/src/sgml/textsearch.sgml @@ -3687,7 +3687,7 @@ SELECT plainto_tsquery('supernovae stars'); - A GiST index can be covering, i.e. use the INCLUDE + A GiST index can be covering, i.e., use the INCLUDE clause. Included columns can have data types without any GiST operator class. Included attributes will be stored uncompressed. @@ -3713,7 +3713,7 @@ SELECT plainto_tsquery('supernovae stars'); allows the implementation of very fast searches with online update. Partitioning can be done at the database level using table inheritance, or by distributing documents over - servers and collecting external search results, e.g. via Foreign Data access. The latter is possible because ranking functions use only local information. diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index bd9fae544c1..a94edf4d8b6 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -266,7 +266,7 @@ overhead can reduce performance, especially if journaling causes file system data to be flushed to disk. Fortunately, data flushing during journaling can - often be disabled with a file system mount option, e.g. + often be disabled with a file system mount option, e.g., data=writeback on a Linux ext3 file system. Journaled file systems do improve boot speed after a crash. diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 9d94094bc18..33c5b827959 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -152,9 +152,9 @@ Besides SELECT queries, the commands can include data modification queries (INSERT, UPDATE, and DELETE), as well as - other SQL commands. (You cannot use transaction control commands, e.g. + other SQL commands. (You cannot use transaction control commands, e.g., COMMIT, SAVEPOINT, and some utility - commands, e.g. VACUUM, in SQL functions.) + commands, e.g., VACUUM, in SQL functions.) However, the final command must be a SELECT or have a RETURNING clause that returns whatever is @@ -3359,7 +3359,7 @@ if (!ptr) exceptions. Any exceptions must be caught and appropriate errors passed back to the C interface. If possible, compile C++ with to eliminate exceptions entirely; in such - cases, you must check for failures in your C++ code, e.g. check for + cases, you must check for failures in your C++ code, e.g., check for NULL returned by new(). diff --git a/doc/src/sgml/xml2.sgml b/doc/src/sgml/xml2.sgml index 560faa000ec..f5346336104 100644 --- a/doc/src/sgml/xml2.sgml +++ b/doc/src/sgml/xml2.sgml @@ -327,7 +327,7 @@ AS t(article_id integer, author text, page_count integer, title text); The calling SELECT statement doesn't necessarily have to be just SELECT * — it can reference the output columns by name or join them to other tables. The function produces a - virtual table with which you can perform any operation you wish (e.g. + virtual table with which you can perform any operation you wish (e.g., aggregation, joining, sorting etc). So we could also have: SELECT t.title, p.fullname, p.email