Skip to content

Commit ffc61f8

Browse files
bmomjianbmomjian
committed
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
1 parent 7d26d85 commit ffc61f8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+94
-94
lines changed

‎doc/src/sgml/config.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ include_dir 'directory'
407407
start with the <literal>.</literal> character are also ignored, to
408408
prevent mistakes since such files are hidden on some platforms. Multiple
409409
files within an include directory are processed in file name order
410-
(according to C locale rules, i.e. numbers before letters, and
410+
(according to C locale rules, i.e., numbers before letters, and
411411
uppercase letters before lowercase ones).
412412
</para>
413413

@@ -1304,7 +1304,7 @@ include_dir 'conf.d'
13041304
<para>
13051305
With this parameter enabled, you can still create ordinary global
13061306
users. Simply append <literal>@</> when specifying the user
1307-
name in the client, e.g. <literal>joe@</>. The <literal>@</>
1307+
name in the client, e.g., <literal>joe@</>. The <literal>@</>
13081308
will be stripped off before the user name is looked up by the
13091309
server.
13101310
</para>
@@ -2886,7 +2886,7 @@ include_dir 'conf.d'
28862886
disabled, but the server continues to accumulate WAL segment files in
28872887
the expectation that a command will soon be provided. Setting
28882888
<varname>archive_command</> to a command that does nothing but
2889-
return true, e.g. <literal>/bin/true</> (<literal>REM</> on
2889+
return true, e.g., <literal>/bin/true</> (<literal>REM</> on
28902890
Windows), effectively disables
28912891
archiving, but also breaks the chain of WAL files needed for
28922892
archive recovery, so it should only be used in unusual circumstances.
@@ -3836,7 +3836,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
38363836
if your data is likely to be completely in cache, such as when
38373837
the database is smaller than the total server memory, decreasing
38383838
random_page_cost can be appropriate. Storage that has a low random
3839-
read cost relative to sequential, e.g. solid-state drives, might
3839+
read cost relative to sequential, e.g., solid-state drives, might
38403840
also be better modeled with a lower value for random_page_cost,
38413841
e.g., <literal>1.1</literal>.
38423842
</para>
@@ -7384,7 +7384,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
73847384
rows that can be locked; that value is unlimited. The default,
73857385
64, has historically proven sufficient, but you might need to
73867386
raise this value if you have queries that touch many different
7387-
tables in a single transaction, e.g. query of a parent table with
7387+
tables in a single transaction, e.g., query of a parent table with
73887388
many children. This parameter can only be set at server start.
73897389
</para>
73907390

@@ -7895,7 +7895,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
78957895
with assertions enabled. That is the case if the
78967896
macro <symbol>USE_ASSERT_CHECKING</symbol> is defined
78977897
when <productname>PostgreSQL</productname> is built (accomplished
7898-
e.g. by the <command>configure</command> option
7898+
e.g., by the <command>configure</command> option
78997899
<option>--enable-cassert</option>). By
79007900
default <productname>PostgreSQL</productname> is built without
79017901
assertions.

‎doc/src/sgml/datatype.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@
507507
very large number of digits. It is especially recommended for
508508
storing monetary amounts and other quantities where exactness is
509509
required. Calculations with <type>numeric</type> values yield exact
510-
results where possible, e.g. addition, subtraction, multiplication.
510+
results where possible, e.g., addition, subtraction, multiplication.
511511
However, calculations on <type>numeric</type> values are very slow
512512
compared to the integer types, or to the floating-point types
513513
described in the next section.
@@ -4870,7 +4870,7 @@ SELECT * FROM pg_attribute
48704870

48714871
<row>
48724872
<entry><type>unknown</></entry>
4873-
<entry>Identifies a not-yet-resolved type, e.g. of an undecorated
4873+
<entry>Identifies a not-yet-resolved type, e.g., of an undecorated
48744874
string literal.</entry>
48754875
</row>
48764876

‎doc/src/sgml/ddl.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1511,7 +1511,7 @@ ALTER TABLE products RENAME TO items;
15111511

15121512
<para>
15131513
An object can be assigned to a new owner with an <command>ALTER</command>
1514-
command of the appropriate kind for the object, e.g. <xref
1514+
command of the appropriate kind for the object, e.g., <xref
15151515
linkend="sql-altertable">. Superusers can always do
15161516
this; ordinary roles can only do it if they are both the current owner
15171517
of the object (or a member of the owning role) and a member of the new

‎doc/src/sgml/ecpg.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3659,7 +3659,7 @@ EXEC SQL DEALLOCATE DESCRIPTOR <replaceable>identifier</replaceable>;
36593659
EXEC SQL FETCH NEXT FROM mycursor INTO SQL DESCRIPTOR mydesc;
36603660
</programlisting>
36613661
If the result set is empty, the Descriptor Area will still contain
3662-
the metadata from the query, i.e. the field names.
3662+
the metadata from the query, i.e., the field names.
36633663
</para>
36643664

36653665
<para>
@@ -4076,7 +4076,7 @@ typedef struct sqlvar_struct sqlvar_t;
40764076
<term><literal>sqllen</></term>
40774077
<listitem>
40784078
<para>
4079-
Contains the binary length of the field. e.g. 4 bytes for <type>ECPGt_int</type>.
4079+
Contains the binary length of the field. e.g., 4 bytes for <type>ECPGt_int</type>.
40804080
</para>
40814081
</listitem>
40824082
</varlistentry>
@@ -8003,7 +8003,7 @@ EXEC SQL CLOSE DATABASE;
80038003
<term><literal>FREE cursor_name</></term>
80048004
<listitem>
80058005
<para>
8006-
Due to the differences how ECPG works compared to Informix's ESQL/C (i.e. which steps
8006+
Due to the differences how ECPG works compared to Informix's ESQL/C (i.e., which steps
80078007
are purely grammar transformations and which steps rely on the underlying run-time library)
80088008
there is no <literal>FREE cursor_name</> statement in ECPG. This is because in ECPG,
80098009
<literal>DECLARE CURSOR</literal> doesn't translate to a function call into

‎doc/src/sgml/extend.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,7 @@
542542
<para>
543543
An extension is <firstterm>relocatable</> if it is possible to move
544544
its contained objects into a different schema after initial creation
545-
of the extension. The default is <literal>false</>, i.e. the
545+
of the extension. The default is <literal>false</>, i.e., the
546546
extension is not relocatable.
547547
See <xref linkend="extend-extensions-relocation"> for more information.
548548
</para>
@@ -1363,7 +1363,7 @@ include $(PGXS)
13631363
<term><varname>NO_INSTALLCHECK</varname></term>
13641364
<listitem>
13651365
<para>
1366-
don't define an <literal>installcheck</literal> target, useful e.g. if tests require special configuration, or don't use <application>pg_regress</application>
1366+
don't define an <literal>installcheck</literal> target, useful e.g., if tests require special configuration, or don't use <application>pg_regress</application>
13671367
</para>
13681368
</listitem>
13691369
</varlistentry>

‎doc/src/sgml/func.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6211,7 +6211,7 @@ SELECT regexp_match('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
62116211
will be replaced by the year data, but the single <literal>Y</literal> in <literal>Year</literal>
62126212
will not be. In <function>to_date</>, <function>to_number</>,
62136213
and <function>to_timestamp</>, double-quoted strings skip the number of
6214-
input characters contained in the string, e.g. <literal>"XX"</>
6214+
input characters contained in the string, e.g., <literal>"XX"</>
62156215
skips two input characters.
62166216
</para>
62176217
</listitem>
@@ -6227,9 +6227,9 @@ SELECT regexp_match('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
62276227
<listitem>
62286228
<para>
62296229
In <function>to_timestamp</function> and <function>to_date</function>,
6230-
if the year format specification is less than four digits, e.g.
6230+
if the year format specification is less than four digits, e.g.,
62316231
<literal>YYY</>, and the supplied year is less than four digits,
6232-
the year will be adjusted to be nearest to the year 2020, e.g.
6232+
the year will be adjusted to be nearest to the year 2020, e.g.,
62336233
<literal>95</> becomes 1995.
62346234
</para>
62356235
</listitem>
@@ -20607,7 +20607,7 @@ FOR EACH ROW EXECUTE PROCEDURE suppress_redundant_updates_trigger();
2060720607
<row>
2060820608
<entry><literal>objsubid</literal></entry>
2060920609
<entry><type>integer</type></entry>
20610-
<entry>Sub-object ID (e.g. attribute number for a column)</entry>
20610+
<entry>Sub-object ID (e.g., attribute number for a column)</entry>
2061120611
</row>
2061220612
<row>
2061320613
<entry><literal>command_tag</literal></entry>
@@ -20694,7 +20694,7 @@ FOR EACH ROW EXECUTE PROCEDURE suppress_redundant_updates_trigger();
2069420694
<row>
2069520695
<entry><literal>objsubid</literal></entry>
2069620696
<entry><type>integer</type></entry>
20697-
<entry>Sub-object ID (e.g. attribute number for a column)</entry>
20697+
<entry>Sub-object ID (e.g., attribute number for a column)</entry>
2069820698
</row>
2069920699
<row>
2070020700
<entry><literal>original</literal></entry>

‎doc/src/sgml/high-availability.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ protocol to make nodes agree on a serializable transactional order.
219219
this is unacceptable, either the middleware or the application
220220
must query such values from a single server and then use those
221221
values in write queries. Another option is to use this replication
222-
option with a traditional master-standby setup, i.e. data modification
222+
option with a traditional master-standby setup, i.e., data modification
223223
queries are sent only to the master and are propagated to the
224224
standby servers via master-standby replication, not by the replication
225225
middleware. Care must also be taken that all
@@ -657,7 +657,7 @@ protocol to make nodes agree on a serializable transactional order.
657657
Set up continuous archiving on the primary to an archive directory
658658
accessible from the standby, as described
659659
in <xref linkend="continuous-archiving">. The archive location should be
660-
accessible from the standby even when the master is down, i.e. it should
660+
accessible from the standby even when the master is down, i.e., it should
661661
reside on the standby server itself or another trusted server, not on
662662
the master server.
663663
</para>
@@ -2213,7 +2213,7 @@ LOG: database system is ready to accept read only connections
22132213
<itemizedlist>
22142214
<listitem>
22152215
<para>
2216-
Data Definition Language (DDL) - e.g. <command>CREATE INDEX</>
2216+
Data Definition Language (DDL) - e.g., <command>CREATE INDEX</>
22172217
</para>
22182218
</listitem>
22192219
<listitem>
@@ -2279,7 +2279,7 @@ LOG: database system is ready to accept read only connections
22792279

22802280
<para>
22812281
WAL file control commands will not work during recovery,
2282-
e.g. <function>pg_start_backup</>, <function>pg_switch_wal</> etc.
2282+
e.g., <function>pg_start_backup</>, <function>pg_switch_wal</> etc.
22832283
</para>
22842284

22852285
<para>

‎doc/src/sgml/indexam.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ amcanreturn (Relation indexRelation, int attno);
368368
linkend="indexes-index-only-scans"><firstterm>index-only scans</></link> on
369369
the given column, by returning the indexed column values for an index entry
370370
in the form of an <structname>IndexTuple</structname>. The attribute number
371-
is 1-based, i.e. the first column's attno is 1. Returns TRUE if supported,
371+
is 1-based, i.e., the first column's attno is 1. Returns TRUE if supported,
372372
else FALSE. If the access method does not support index-only scans at all,
373373
the <structfield>amcanreturn</> field in its <structname>IndexAmRoutine</>
374374
struct can be set to NULL.

‎doc/src/sgml/install-windows.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
In the <productname>Microsoft Windows SDK</productname>, start the
109109
<application>CMD shell</application> listed under the SDK on the Start Menu.
110110
In recent SDK versions you can change the targeted CPU architecture, build
111-
type, and target OS by using the <command>setenv</command> command, e.g.
111+
type, and target OS by using the <command>setenv</command> command, e.g.,
112112
<command>setenv /x86 /release /xp</command> to target Windows XP or later
113113
with a 32-bit release build. See <command>/?</command> for other options to
114114
<command>setenv</command>. All commands should be run from the
@@ -241,7 +241,7 @@ $ENV{MSBFLAGS}="/m";
241241
installations <filename>C:\Program Files\GnuWin32</filename>.
242242
Consider installing into <filename>C:\GnuWin32</filename> or use the
243243
NTFS short name path to GnuWin32 in your PATH environment setting
244-
(e.g. <filename>C:\PROGRA~1\GnuWin32</filename>).
244+
(e.g., <filename>C:\PROGRA~1\GnuWin32</filename>).
245245
</para>
246246
</note>
247247

‎doc/src/sgml/libpq.sgml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
355355
Conversely, if <function>PQconnectPoll(conn)</function> last returned
356356
<symbol>PGRES_POLLING_WRITING</symbol>, wait until the socket is ready
357357
to write, then call <function>PQconnectPoll(conn)</function> again.
358-
On the first iteration, i.e. if you have yet to call
358+
On the first iteration, i.e., if you have yet to call
359359
<function>PQconnectPoll</function>, behave as if it last returned
360360
<symbol>PGRES_POLLING_WRITING</symbol>. Continue this loop until
361361
<function>PQconnectPoll(conn)</function> returns
@@ -860,7 +860,7 @@ postgresql:///mydb?host=localhost&amp;port=5433
860860

861861
<para>
862862
Percent-encoding may be used to include symbols with special meaning in any
863-
of the <acronym>URI</acronym> parts, e.g. replace <literal>=</> with
863+
of the <acronym>URI</acronym> parts, e.g., replace <literal>=</> with
864864
<literal>%3D</>.
865865

866866
</para>
@@ -919,7 +919,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
919919
<literal>hostaddr</>, and <literal>port</> options accept a comma-separated
920920
list of values. The same number of elements must be given in each
921921
option that is specified, such
922-
that e.g. the first <literal>hostaddr</> corresponds to the first host name,
922+
that e.g., the first <literal>hostaddr</> corresponds to the first host name,
923923
the second <literal>hostaddr</> corresponds to the second host name, and so
924924
forth. As an exception, if only one <literal>port</literal> is specified, it
925925
applies to all the hosts.
@@ -947,7 +947,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
947947
<para>
948948
If a password file is used, you can have different passwords for
949949
different hosts. All the other connection options are the same for every
950-
host in the list; it is not possible to e.g. specify different
950+
host in the list; it is not possible to e.g., specify different
951951
usernames for different hosts.
952952
</para>
953953
</sect3>
@@ -1123,7 +1123,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
11231123
<listitem>
11241124
<para>
11251125
Maximum wait for connection, in seconds (write as a decimal integer,
1126-
e.g. <literal>10</literal>). Zero, negative, or not specified means
1126+
e.g., <literal>10</literal>). Zero, negative, or not specified means
11271127
wait indefinitely. The minimum allowed timeout is 2 seconds, therefore
11281128
a value of <literal>1</literal> is interpreted as <literal>2</literal>.
11291129
This timeout applies separately to each host name or IP address.
@@ -2164,7 +2164,7 @@ const char *PQsslAttribute(const PGconn *conn, const char *attribute_name);
21642164
<term><literal>cipher</literal></term>
21652165
<listitem>
21662166
<para>
2167-
A short name of the ciphersuite used, e.g.
2167+
A short name of the ciphersuite used, e.g.,
21682168
<literal>"DHE-RSA-DES-CBC3-SHA"</literal>. The names are specific
21692169
to each SSL implementation.
21702170
</para>
@@ -4811,7 +4811,7 @@ int PQflush(PGconn *conn);
48114811
<function>PQflush</function> again. Repeat until
48124812
<function>PQflush</function> returns 0. (It is necessary to check for
48134813
read-ready and drain the input with <function>PQconsumeInput</function>,
4814-
because the server can block trying to send us data, e.g. NOTICE
4814+
because the server can block trying to send us data, e.g., NOTICE
48154815
messages, and won't read our data until we read its.) Once
48164816
<function>PQflush</function> returns 0, wait for the socket to be
48174817
read-ready and then read the response as described above.
@@ -7820,7 +7820,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
78207820
For a connection to be known secure, SSL usage must be configured
78217821
on <emphasis>both the client and the server</> before the connection
78227822
is made. If it is only configured on the server, the client may end up
7823-
sending sensitive information (e.g. passwords) before
7823+
sending sensitive information (e.g., passwords) before
78247824
it knows that the server requires high security. In libpq, secure
78257825
connections can be ensured
78267826
by setting the <literal>sslmode</> parameter to <literal>verify-full</> or

‎doc/src/sgml/monitoring.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
206206
When the server shuts down cleanly, a permanent copy of the statistics
207207
data is stored in the <filename>pg_stat</filename> subdirectory, so that
208208
statistics can be retained across server restarts. When recovery is
209-
performed at server start (e.g. after immediate shutdown, server crash,
209+
performed at server start (e.g., after immediate shutdown, server crash,
210210
and point-in-time recovery), all statistics counters are reset.
211211
</para>
212212

‎doc/src/sgml/mvcc.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@
269269
<para>
270270
In <productname>PostgreSQL</productname>, you can request any of
271271
the four standard transaction isolation levels, but internally only
272-
three distinct isolation levels are implemented, i.e. PostgreSQL's
272+
three distinct isolation levels are implemented, i.e., PostgreSQL's
273273
Read Uncommitted mode behaves like Read Committed. This is because
274274
it is the only sensible way to map the standard isolation levels to
275275
PostgreSQL's multiversion concurrency control architecture.

‎doc/src/sgml/parallel.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ EXPLAIN SELECT * FROM pgbench_accounts WHERE filler LIKE '%x%';
401401
<xref linkend="guc-parallel-tuple-cost">. Of course, this plan may turn
402402
out to be slower than the serial plan which the planner preferred, but
403403
this will not always be the case. If you don't get a parallel
404-
plan even with very small values of these settings (e.g. after setting
404+
plan even with very small values of these settings (e.g., after setting
405405
them both to zero), there may be some reason why the query planner is
406406
unable to generate a parallel plan for your query. See
407407
<xref linkend="when-can-parallel-query-be-used"> and
@@ -493,7 +493,7 @@ EXPLAIN SELECT * FROM pgbench_accounts WHERE filler LIKE '%x%';
493493
<para>
494494
Functions and aggregates must be marked <literal>PARALLEL UNSAFE</> if
495495
they write to the database, access sequences, change the transaction state
496-
even temporarily (e.g. a PL/pgSQL function which establishes an
496+
even temporarily (e.g., a PL/pgSQL function which establishes an
497497
<literal>EXCEPTION</> block to catch errors), or make persistent changes to
498498
settings. Similarly, functions must be marked <literal>PARALLEL
499499
RESTRICTED</> if they access temporary tables, client connection state,

‎doc/src/sgml/perform.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1808,7 +1808,7 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse;
18081808
<listitem>
18091809
<para>
18101810
Place the database cluster's data directory in a memory-backed
1811-
file system (i.e. <acronym>RAM</> disk). This eliminates all
1811+
file system (i.e., <acronym>RAM</> disk). This eliminates all
18121812
database disk I/O, but limits data storage to the amount of
18131813
available memory (and perhaps swap).
18141814
</para>

0 commit comments

Comments
 (0)