8000 Use the correct article for abbreviations · postgrespro/postgres@04539e7 · GitHub
[go: up one dir, main page]
Skip to content 8000

Commit 04539e7

Browse files
david-rowleydavid-rowley
committed
Use the correct article for abbreviations
We've accumulated quite a mix of instances of "an SQL" and "a SQL" in the documents. It would be good to be a bit more consistent with these. The most recent version of the SQL standard I looked at seems to prefer "an SQL". That seems like a good lead to follow, so here we change all instances of "a SQL" to become "an SQL". Most instances correctly use "an SQL" already, so it also makes sense to use the dominant variation in order to minimise churn. Additionally, there were some other abbreviations that needed to be adjusted. FSM, SSPI, SRF and a few others. Also fix some pronounceable, abbreviations to use "a" instead of "an". For example, "a SASL" instead of "an SASL". Here I've only adjusted the documents and error messages. Many others still exist in source code comments. Translator hint comments seem to be the biggest culprit. It currently does not seem worth the churn to change these. Discussion: https://postgr.es/m/CAApHDvpML27UqFXnrYO1MJddsKVMQoiZisPvsAGhKE_tsKXquw%40mail.gmail.com
1 parent e56bce5 commit 04539e7

35 files changed

+81
-81
lines changed

‎doc/src/sgml/client-auth.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1462,7 +1462,7 @@ omicron bryanh guest1
14621462
<listitem>
14631463
<para>
14641464
Allows for mapping between system and database user names. See
1465-
<xref linkend="auth-username-maps"/> for details. For a SSPI/Kerberos
1465+
<xref linkend="auth-username-maps"/> for details. For an SSPI/Kerberos
14661466
principal, such as <literal>username@EXAMPLE.COM</literal> (or, less
14671467
commonly, <literal>username/hostbased@EXAMPLE.COM</literal>), the
14681468
user name used for mapping is

‎doc/src/sgml/config.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
In general, enclose the value in single quotes, doubling any single
5252
quotes within the value. Quotes can usually be omitted if the value
5353
is a simple number or identifier, however.
54-
(Values that match a SQL keyword require quoting in some contexts.)
54+
(Values that match an SQL keyword require quoting in some contexts.)
5555
</para>
5656
</listitem>
5757

@@ -222,7 +222,7 @@ shared_buffers = 128MB
222222
<productname>PostgreSQL</productname> provides three SQL
223223
commands to establish configuration defaults.
224224
The already-mentioned <command>ALTER SYSTEM</command> command
225-
provides a SQL-accessible means of changing global defaults; it is
225+
provides an SQL-accessible means of changing global defaults; it is
226226
functionally equivalent to editing <filename>postgresql.conf</filename>.
227227
In addition, there are two commands that allow setting of defaults
228228
on a per-database or per-role basis:
@@ -9625,7 +9625,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
96259625
<literal>\'</literal>. However, use of <literal>\'</literal> creates security risks
96269626
because in some client character set encodings, there are multibyte
96279627
characters in which the last byte is numerically equivalent to ASCII
9628-
<literal>\</literal>. If client-side code does escaping incorrectly then a
9628+
<literal>\</literal>. If client-side code does escaping incorrectly then an
96299629
SQL-injection attack is possible. This risk can be prevented by
96309630
making the server reject queries in which a quote mark appears to be
96319631
escaped by a backslash.

‎doc/src/sgml/datatype.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1538,7 +1538,7 @@ SELECT '\xDEADBEEF';
15381538
<para>
15391539
The reason that single quotes must be doubled, as shown
15401540
in <xref linkend="datatype-binary-sqlesc"/>, is that this
1541-
is true for any string literal in a SQL command. The generic
1541+
is true for any string literal in an SQL command. The generic
15421542
string-literal parser consumes the outermost single quotes
15431543
and reduces any pair of single quotes to one data character.
15441544
What the <type>bytea</type> input function sees is just one

‎doc/src/sgml/dblink.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1482,14 +1482,14 @@ dblink_get_result(text connname [, bool fail_on_error]) returns setof record
14821482
<title>Return Value</title>
14831483

14841484
<para>
1485-
For an async query (that is, a SQL statement returning rows),
1485+
For an async query (that is, an SQL statement returning rows),
14861486
the function returns the row(s) produced by the query. To use this
14871487
function, you will need to specify the expected set of columns,
14881488
as previously discussed for <function>dblink</function>.
14891489
</para>
14901490

14911491
<para>
1492-
For an async command (that is, a SQL statement not returning rows),
1492+
For an async command (that is, an SQL statement not returning rows),
14931493
the function returns a single row with a single text column containing
14941494
the command's status string. It is still necessary to specify that
14951495
the result will have a single text column in the calling <literal>FROM</literal>
@@ -1777,7 +1777,7 @@ dblink_build_sql_insert(text relname,
17771777
<para>
17781778
<function>dblink_build_sql_insert</function> can be useful in doing selective
17791779
replication of a local table to a remote database. It selects a row
1780-
from the local table based on primary key, and then builds a SQL
1780+
from the local table based on primary key, and then builds an SQL
17811781
<command>INSERT</command> command that will duplicate that row, but with
17821782
the primary key values replaced by the values in the last argument.
17831783
(To make an exact copy of the row, just specify the same values for
@@ -1909,7 +1909,7 @@ dblink_build_sql_delete(text relname,
19091909

19101910
<para>
19111911
<function>dblink_build_sql_delete</function> can be useful in doing selective
1912-
replication of a local table to a remote database. It builds a SQL
1912+
replication of a local table to a remote database. It builds an SQL
19131913
<command>DELETE</command> command that will delete the row with the given
19141914
primary key values.
19151915
</para>
@@ -2029,7 +2029,7 @@ dblink_build_sql_update(text relname,
20292029
<para>
20302030
<function>dblink_build_sql_update</function> can be useful in doing selective
20312031
replication of a local table to a remote database. It selects a row
2032-
from the local table based on primary key, and then builds a SQL
2032+
from the local table based on primary key, and then builds an SQL
20332033
<command>UPDATE</command> command that will duplicate that row, but with
20342034
the primary key values replaced by the values in the last argument.
20352035
(To make an exact copy of the row, just specify the same values for

‎doc/src/sgml/ecpg.sgml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -354,13 +354,13 @@ current=testdb1 (should be testdb1)
354354
</para>
355355

356356
<para>
357-
The third option is to declare a SQL identifier linked to
357+
The third option is to declare an SQL identifier linked to
358358
the connection, for example:
359359
<programlisting>
360360
EXEC SQL AT <replaceable>connection-name</replaceable> DECLARE <replaceable>statement-name</replaceable> STATEMENT;
361361
EXEC SQL PREPARE <replaceable>statement-name</replaceable> FROM :<replaceable>dyn-string</replaceable>;
362362
</programlisting>
363-
Once you link a SQL identifier to a connection, you execute dynamic SQL
363+
Once you link an SQL identifier to a connection, you execute dynamic SQL
364364
without an AT clause. Note that this option behaves like preprocessor
365365
directives, therefore the link is enabled only in the file.
366366
</para>
@@ -1542,7 +1542,7 @@ EXEC SQL END DECLARE SECTION;
15421542
variables and vice-versa. However, when creating a statement ecpg does
15431543
not know the types of the columns, so that it cannot check if a C array
15441544
is input into a corresponding SQL-level array. When processing the
1545-
output of a SQL statement, ecpg has the necessary information and thus
1545+
output of an SQL statement, ecpg has the necessary information and thus
15461546
checks if both are arrays.
15471547
</para>
15481548

@@ -4348,7 +4348,7 @@ switch (v.sqltype)
43484348
parameters to a prepared query are:
43494349
</para>
43504350
<step><simpara>Create a prepared query (prepared statement)</simpara></step>
4351-
<step><simpara>Declare a sqlda_t structure as an input SQLDA.</simpara></step>
4351+
<step><simpara>Declare an sqlda_t structure as an input SQLDA.</simpara></step>
43524352
<step><simpara>Allocate memory area (as sqlda_t structure) for the input SQLDA.</simpara></step>
43534353
<step><simpara>Set (copy) input values in the allocated memory.</simpara></step>
43544354
<step><simpara>Open a cursor with specifying the input SQLDA.</simpara></step>
@@ -4630,7 +4630,7 @@ main(void)
46304630
EXEC SQL PREPARE stmt1 FROM :query;
46314631
EXEC SQL DECLARE cur1 CURSOR FOR stmt1;
46324632

4633-
/* Create a SQLDA structure for an input parameter */
4633+
/* Create an SQLDA structure for an input parameter */
46344634
sqlda2 = (sqlda_t *)malloc(sizeof(sqlda_t) + sizeof(sqlvar_t));
46354635
memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t));
46364636
sqlda2->sqln = 2; /* a number of input variables */
@@ -6911,7 +6911,7 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
69116911
<title>Description</title>
69126912

69136913
<para>
6914-
<command>DECLARE STATEMENT</command> declares a SQL statement identifier.
6914+
<command>DECLARE STATEMENT</command> declares an SQL statement identifier.
69156915
SQL statement identifier can be associated with the connection.
69166916
When the identifier is used by dynamic SQL statements, the statements
69176917
are executed using the associated connection.
@@ -6945,7 +6945,7 @@ EXEC SQL [ AT <replaceable class="parameter">connection_name</replaceable> ] DEC
69456945
<term><replaceable class="parameter">statement_name</replaceable></term>
69466946
<listitem>
69476947
<para>
6948-
The name of a SQL statement identifier, either as an SQL identifier or a host variable.
6948+
The name of an SQL statement identifier, either as an SQL identifier or a host variable.
69496949
</para>
69506950
</listitem>
69516951
</varlistentry>

‎doc/src/sgml/extend.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1441,7 +1441,7 @@ include $(PGXS)
14411441
and include the global <acronym>PGXS</acronym> makefile.
14421442
Here is an example that builds an extension module named
14431443
<literal>isbn_issn</literal>, consisting of a shared library containing
1444-
some C code, an extension control file, a SQL script, an include file
1444+
some C code, an extension control file, an SQL script, an include file
14451445
(only needed if other modules might need to access the extension functions
14461446
without going via SQL), and a documentation text file:
14471447
<programlisting>

‎doc/src/sgml/func.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15196,7 +15196,7 @@ table2-mapping
1519615196
<returnvalue>json</returnvalue>
1519715197
</para>
1519815198
<para>
15199-
Converts a SQL array to a JSON array. The behavior is the same
15199+
Converts an SQL array to a JSON array. The behavior is the same
1520015200
as <function>to_json</function> except that line feeds will be added
1520115201
between top-level array elements if the optional boolean parameter is
1520215202
true.
@@ -15216,7 +15216,7 @@ table2-mapping
1521615216
<returnvalue>json</returnvalue>
1521715217
</para>
1521815218
<para>
15219-
Converts a SQL composite value to a JSON object. The behavior is the
15219+
Converts an SQL composite value to a JSON object. The behavior is the
1522015220
same as <function>to_json</function> except that line feeds will be
1522115221
added between top-level elements if the optional boolean parameter is
1522215222
true.
@@ -15629,7 +15629,7 @@ table2-mapping
1562915629
<itemizedlist spacing="compact">
1563015630
<listitem>
1563115631
<para>
15632-
A JSON null value is converted to a SQL null in all cases.
15632+
A JSON null value is converted to an SQL null in all cases.
1563315633
</para>
1563415634
</listitem>
1563515635
<listitem>
@@ -16152,7 +16152,7 @@ table2-mapping
1615216152
<literal>string</literal>, <literal>number</literal>,
1615316153
<literal>boolean</literal>, and <literal>null</literal>.
1615416154
(The <literal>null</literal> result should not be confused
16155-
with a SQL NULL; see the examples.)
16155+
with an SQL NULL; see the examples.)
1615616156
</para>
1615716157
<para>
1615816158
<literal>json_typeof('-123.4')</literal>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2194,7 +2194,7 @@ HINT: You can then restart the server after making the necessary configuration
21942194
Currently, temporary table creation is not allowed during read only
21952195
transactions, so in some cases existing scripts will not run correctly.
21962196
This restriction might be relaxed in a later release. This is
2197-
both a SQL Standard compliance issue and a technical issue.
2197+
both an SQL Standard compliance issue and a technical issue.
21982198
</para>
21992199

22002200
<para>

‎doc/src/sgml/indexam.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ aminsert (Relation indexRelation,
338338

339339
<para>
340340
If the index AM wishes to cache data across successive index insertions
341-
within a SQL statement, it can allocate space
341+
within an SQL statement, it can allocate space
342342
in <literal>indexInfo-&gt;ii_Context</literal> and store a pointer to the
343343
data in <literal>indexInfo-&gt;ii_AmCache</literal> (which will be NULL
344344
initially).

‎doc/src/sgml/libpq.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3468,7 +3468,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode);
34683468
<listitem>
34693469
<para>
34703470
The text of a failed internally-generated command. This could
3471-
be, for example, a SQL query issued by a PL/pgSQL function.
3471+
be, for example, an SQL query issued by a PL/pgSQL function.
34723472
</para>
34733473
</listitem>
34743474
</varlistentry>
@@ -5468,7 +5468,7 @@ UPDATE mytable SET x = x + 1 WHERE id = 42;
54685468
</indexterm>
54695469

54705470
<para>
5471-
Ordinarily, <application>libpq</application> collects a SQL command's
5471+
Ordinarily, <application>libpq</application> collects an SQL command's
54725472
entire result and returns it to the application as a single
54735473
<structname>PGresult</structname>. This can be unworkable for commands
54745474
that return a large number of rows. For such cases, applications can use

0 commit comments

Comments
 (0)
0