Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 410aa24

Browse files
michaelpqmichaelpq
committed
Fix various typos, grammar and code style in comments and docs
This fixes a set of issues that have accumulated over the past months (or years) in various code areas. Most fixes are related to some recent additions, as of the development of v15. Author: Justin Pryzby Discussion: https://postgr.es/m/20220124030001.GQ23027@telsasoft.com
1 parent c817a07 commit 410aa24

Some content is hidden

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

44 files changed

+164
-165
lines changed

‎doc/src/sgml/config.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8442,8 +8442,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
84428442
This parameter specifies the default table access method to use when
84438443
creating tables or materialized views if the <command>CREATE</command>
84448444
command does not explicitly specify an access method, or when
8445-
<command>SELECT ... INTO</command> is used, which does not allow to
8446-
specify a table access method. The default is <literal>heap</literal>.
8445+
<command>SELECT ... INTO</command> is used, which does not allow
8446+
specifying a table access method. The default is <literal>heap</literal>.
84478447
</para>
84488448
</listitem>
84498449
</varlistentry>

‎doc/src/sgml/ddl.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1071,7 +1071,7 @@ CREATE TABLE order_items (
10711071
represent independent objects, then <literal>RESTRICT</literal> or
10721072
<literal>NO ACTION</literal> is more appropriate; an application that
10731073
actually wants to delete both objects would then have to be explicit about
1074-
this and run two delete options. In the above example, order items are
1074+
this and run two delete commands. In the above example, order items are
10751075
part of an order, and it is convenient if they are deleted automatically
10761076
if an order is deleted. But products and orders are different things, and
10771077
so making a deletion of a product automatically cause the deletion of some
@@ -4044,7 +4044,7 @@ ALTER TABLE measurement ATTACH PARTITION measurement_y2008m02
40444044
holding an <literal>ACCESS EXCLUSIVE</literal> lock on that partition.
40454045
It is recommended to drop the now-redundant <literal>CHECK</literal>
40464046
constraint after the <command>ATTACH PARTITION</command> is complete. If
4047-
the table being attached is itself a partitioned table then each of its
4047+
the table being attached is itself a partitioned table, then each of its
40484048
sub-partitions will be recursively locked and scanned until either a
40494049
suitable <literal>CHECK</literal> constraint is encountered or the leaf
40504050
partitions are reached.
@@ -4059,7 +4059,7 @@ ALTER TABLE measurement ATTACH PARTITION measurement_y2008m02
40594059
the partition being attached. This operation will be performed whilst
40604060
holding an <literal>ACCESS EXCLUSIVE</literal> lock on the <literal>
40614061
DEFAULT</literal> partition. If the <literal>DEFAULT</literal> partition
4062-
is itself a partitioned table then each of its partitions will be
4062+
is itself a partitioned table, then each of its partitions will be
40634063
recursively checked in the same way as the table being attached, as
40644064
mentioned above.
40654065
</para>

‎doc/src/sgml/func.sgml

+73-72
Original file line numberDiff line numberDiff line change
@@ -27367,6 +27367,79 @@ SELECT pg_size_pretty(sum(pg_relation_size(relid))) AS total_size
2736727367
</para></entry>
2736827368
</row>
2736927369

27370+
<row>
27371+
<entry role="func_table_entry"><para role="func_signature">
27372+
<indexterm>
27373+
<primary>pg_ls_logicalmapdir</primary>
27374+
</indexterm>
27375+
<function>pg_ls_logicalmapdir</function> ()
27376+
<returnvalue>setof record</returnvalue>
27377+
( <parameter>name</parameter> <type>text</type>,
27378+
<parameter>size</parameter> <type>bigint</type>,
27379+
<parameter>modification</parameter> <type>timestamp with time zone</type> )
27380+
</para>
27381+
<para>
27382+
Returns the name, size, and last modification time (mtime) of each
27383+
ordinary file in the server's <filename>pg_logical/mappings</filename>
27384+
directory. Filenames beginning with a dot, directories, and other
27385+
special files are excluded.
27386+
</para>
27387+
<para>
27388+
This function is restricted to superusers and members of
27389+
the <literal>pg_monitor</literal> role by default, but other users can
27390+
be granted EXECUTE to run the function.
27391+
</para></entry>
27392+
</row>
27393+
27394+
<row>
27395+
<entry role="func_table_entry"><para role="func_signature">
27396+
<indexterm>
27397+
<primary>pg_ls_logicalsnapdir</primary>
27398+
</indexterm>
27399+
<function>pg_ls_logicalsnapdir</function> ()
27400+
<returnvalue>setof record</returnvalue>
27401+
( <parameter>name</parameter> <type>text</type>,
27402+
<parameter>size</parameter> <type>bigint</type>,
27403+
<parameter>modification</parameter> <type>timestamp with time zone</type> )
27404+
</para>
27405+
<para>
27406+
Returns the name, size, and last modification time (mtime) of each
27407+
ordinary file in the server's <filename>pg_logical/snapshots</filename>
27408+
directory. Filenames beginning with a dot, directories, and other
27409+
special files are excluded.
27410+
</para>
27411+
<para>
27412+
This function is restricted to superusers and members of
27413+
the <literal>pg_monitor</literal> role by default, but other users can
27414+
be granted EXECUTE to run the function.
27415+
</para></entry>
27416+
</row>
27417+
27418+
<row>
27419+
<entry role="func_table_entry"><para role="func_signature">
27420+
<indexterm>
27421+
<primary>pg_ls_replslotdir</primary>
27422+
</indexterm>
27423+
<function>pg_ls_replslotdir</function> ( <parameter>slot_name</parameter> <type>text</type> )
27424+
<returnvalue>setof record</returnvalue>
27425+
( <parameter>name</parameter> <type>text</type>,
27426+
<parameter>size</parameter> <type>bigint</type>,
27427+
<parameter>modification</parameter> <type>timestamp with time zone</type> )
27428+
</para>
27429+
<para>
27430+
Returns the name, size, and last modification time (mtime) of each
27431+
ordinary file in the server's <filename>pg_replslot/slot_name</filename>
27432+
directory, where <parameter>slot_name</parameter> is the name of the
27433+
replication slot provided as input of the function. Filenames beginning
27434+
with a dot, directories, and other special files are excluded.
27435+
</para>
27436+
<para>
27437+
This function is restricted to superusers and members of
27438+
the <literal>pg_monitor</literal> role by default, but other users can
27439+
be granted EXECUTE to run the function.
27440+
</para></entry>
27441+
</row>
27442+
2737027443
<row>
2737127444
<entry role="func_table_entry"><para role="func_signature">
2737227445
<indexterm>
@@ -27498,78 +27571,6 @@ SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');
2749827571
</para></entry>
2749927572
</row>
2750027573

27501-
<row>
27502-
<entry role="func_table_entry"><para role="func_signature">
27503-
<indexterm>
27504-
<primary>pg_ls_logicalsnapdir</primary>
27505-
</indexterm>
27506-
<function>pg_ls_logicalsnapdir</function> ()
27507-
<returnvalue>setof record</returnvalue>
27508-
( <parameter>name</parameter> <type>text</type>,
27509-
<parameter>size</parameter> <type>bigint</type>,
27510-
<parameter>modification</parameter> <type>timestamp with time zone</type> )
27511-
</para>
27512-
<para>
27513-
Returns the name, size, and last modification time (mtime) of each
27514-
ordinary file in the server's <filename>pg_logical/snapshots</filename>
27515-
directory. Filenames beginning with a dot, directories, and other
27516-
special files are excluded.
27517-
</para>
27518-
<para>
27519-
This function is restricted to superusers and members of
27520-
the <literal>pg_monitor</literal> role by default, but other users can
27521-
be granted EXECUTE to run the function.
27522-
</para></entry>
27523-
</row>
27524-
27525-
<row>
27526-
<entry role="func_table_entry"><para role="func_signature">
27527-
<indexterm>
27528-
<primary>pg_ls_logicalmapdir</primary>
27529-
</indexterm>
27530-
<function>pg_ls_logicalmapdir</function> ()
27531-
<returnvalue>setof record</returnvalue>
27532-
( <parameter>name</parameter> <type>text</type>,
27533-
<parameter>size</parameter> <type>bigint</type>,
27534-
<parameter>modification</parameter> <type>timestamp with time zone</type> )
27535-
</para>
27536-
<para>
27537-
Returns the name, size, and last modification time (mtime) of each
27538-
ordinary file in the server's <filename>pg_logical/mappings</filename>
27539-
directory. Filenames beginning with a dot, directories, and other
27540-
special files are excluded.
27541-
</para>
27542-
<para>
27543-
This function is restricted to superusers and members of
27544-
the <literal>pg_monitor</literal> role by default, but other users can
27545-
be granted EXECUTE to run the function.
27546-
</para></entry>
27547-
</row>
27548-
27549-
<row>
27550-
<entry role="func_table_entry"><para role="func_signature">
27551-
<indexterm>
27552-
<primary>pg_ls_replslotdir</primary>
27553-
</indexterm>
27554-
<function>pg_ls_replslotdir</function> ( <parameter>slot_name</parameter> <type>text</type> )
27555-
<returnvalue>setof record</returnvalue>
27556-
( <parameter>name</parameter> <type>text</type>,
27557-
<parameter>size</parameter> <type>bigint</type>,
27558-
<parameter>modification</parameter> <type>timestamp with time zone</type> )
27559-
</para>
27560-
<para>
27561-
Returns the name, size, and last modification time (mtime) of each
27562-
ordinary file in the server's <filename>pg_replslot/slot_name</filename>
27563-
directory, where <parameter>slot_name</parameter> is the name of the
27564-
replication slot provided as input of the function. Filenames beginning
27565-
with a dot, directories, and other special files are excluded.
27566-
</para>
27567-
<para>
27568-
This function is restricted to superusers and members of
27569-
the <literal>pg_monitor</literal> role by default, but other users can
27570-
be granted EXECUTE to run the function.
27571-
</para></entry>
27572-
</row>
2757327574
</tbody>
2757427575
</tgroup>
2757527576
</table>

‎doc/src/sgml/glossary.sgml

+16-16
Original file line numberDiff line numberDiff line change
@@ -1489,22 +1489,6 @@
14891489
</glossdef>
14901490
</glossentry>
14911491

1492-
<glossentry id="glossary-startup-process">
1493-
<glossterm>Startup process</glossterm>
1494-
<glossdef>
1495-
<para>
1496-
An <glossterm linkend="glossary-auxiliary-proc">auxiliary process</glossterm>
1497-
that replays WAL during crash recovery and in a
1498-
<glossterm linkend="glossary-replication">physical replica</glossterm>.
1499-
</para>
1500-
<para>
1501-
(The name is historical: the startup process was named before
1502-
replication was implemented; the name refers to its task as it
1503-
relates to the server startup following a crash.)
1504-
</para>
1505-
</glossdef>
1506-
</glossentry>
1507-
15081492
<glossentry id="glossary-sql-object">
15091493
<glossterm>SQL object</glossterm>
15101494
<glossdef>
@@ -1563,6 +1547,22 @@
15631547
<glosssee otherterm="glossary-replica" />
15641548
</glossentry>
15651549

1550+
<glossentry id="glossary-startup-process">
1551+
<glossterm>Startup process</glossterm>
1552+
<glossdef>
1553+
<para>
1554+
An <glossterm linkend="glossary-auxiliary-proc">auxiliary process</glossterm>
1555+
that replays WAL during crash recovery and in a
1556+
<glossterm linkend="glossary-replication">physical replica</glossterm>.
1557+
</para>
1558+
<para>
1559+
(The name is historical: the startup process was named before
1560+
replication was implemented; the name refers to its task as it
1561+
relates to the server startup following a crash.)
1562+
</para>
1563+
</glossdef>
1564+
</glossentry>
1565+
15661566
<glossentry id="glossary-stats-collector">
15671567
<glossterm>Stats collector (process)</glossterm>
15681568
<glossdef>

‎doc/src/sgml/indexam.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ typedef struct IndexAmRoutine
253253
access method blocks <acronym>HOT</acronym> when an indexed attribute is
254254
updated. Access methods without pointers to individual tuples (like
255255
<acronym>BRIN</acronym>) may allow <acronym>HOT</acronym> even in this
256-
case. This does not apply to attributes referenced in index predicates,
256+
case. This does not apply to attributes referenced in index predicates;
257257
an update of such attribute always disables <acronym>HOT</acronym>.
258258
</para>
259259

‎doc/src/sgml/perform.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1337,7 +1337,7 @@ nd | {"1, 2": 33178, "1, 5": 33178, "2, 5": 27435, "1, 2, 5": 33178}
13371337
<title>Multivariate MCV Lists</title>
13381338

13391339
<para>
1340-
Another type of statistics stored for each column are most-common value
1340+
Another type of statistic stored for each column are most-common value
13411341
lists. This allows very accurate estimates for individual columns, but
13421342
may result in significant misestimates for queries with conditions on
13431343
multiple columns.

‎doc/src/sgml/postgres-fdw.sgml

+6-6
Original file line numberDiff line numberDiff line change
@@ -955,8 +955,8 @@ postgres=# SELECT postgres_fdw_disconnect_all();
955955
of any length and contain even non-ASCII characters. However when
956956
it's passed to and used as <varname>application_name</varname>
957957
in a foreign server, note that it will be truncated to less than
958-
<symbol>NAMEDATALEN</symbol> characters and any characters other
959-
than printable ASCII ones in it will be replaced with question
958+
<symbol>NAMEDATALEN</symbol> characters and anything other than
959+
than printable ASCII characters will be replaced with question
960960
marks (<literal>?</literal>).
961961
See <xref linkend="guc-application-name"/> for details.
962962
</para>
@@ -981,19 +981,19 @@ postgres=# SELECT postgres_fdw_disconnect_all();
981981
<tbody>
982982
<row>
983983
<entry><literal>%a</literal></entry>
984-
<entry>Application name in local server</entry>
984+
<entry>Application name on local server</entry>
985985
</row>
986986
<row>
987987
<entry><literal>%u</literal></entry>
988-
<entry>User name in local server</entry>
988+
<entry>User name on local server</entry>
989989
</row>
990990
<row>
991991
<entry><literal>%d</literal></entry>
992-
<entry>Database name in local server</entry>
992+
<entry>Database name on local server</entry>
993993
</row>
994994
<row>
995995
<entry><literal>%p</literal></entry>
996-
<entry>Process ID of backend in local server</entry>
996+
<entry>Process ID of backend on local server</entry>
997997
</row>
998998
<row>
999999
<entry><literal>%%</literal></entry>

‎doc/src/sgml/protocol.sgml

+5-5
Original file line numberDiff line numberDiff line change
@@ -2101,7 +2101,7 @@ The commands accepted in replication mode are:
21012101
</term>
21022102
<listitem>
21032103
<para>
2104-
Read some information associated to a replication slot. Returns a tuple
2104+
Read some information associated with a replication slot. Returns a tuple
21052105
with <literal>NULL</literal> values if the replication slot does not
21062106
exist. This command is currently only supported for physical replication
21072107
slots.
@@ -2133,7 +2133,7 @@ The commands accepted in replication mode are:
21332133
<term><literal>restart_tli</literal> (<type>int8</type>)</term>
21342134
<listitem>
21352135
<para>
2136-
The timeline ID associated to <literal>restart_lsn</literal>,
2136+
The timeline ID associated with <literal>restart_lsn</literal>,
21372137
following the current timeline history.
21382138
</para>
21392139
</listitem>
@@ -2155,7 +2155,7 @@ The commands accepted in replication mode are:
21552155
streaming starts on timeline <replaceable class="parameter">tli</replaceable>;
21562156
otherwise, the server's current timeline is selected. The server can
21572157
reply with an error, for example if the requested section of WAL has already
2158-
been recycled. On success, server responds with a CopyBothResponse
2158+
been recycled. On success, the server responds with a CopyBothResponse
21592159
message, and then starts to stream WAL to the frontend.
21602160
</para>
21612161

@@ -2516,7 +2516,7 @@ The commands accepted in replication mode are:
25162516

25172517
<para>
25182518
The server can reply with an error, for example if the
2519-
slot does not exist. On success, server responds with a CopyBothResponse
2519+
slot does not exist. On success, the server responds with a CopyBothResponse
25202520
message, and then starts to stream WAL to the frontend.
25212521
</para>
25222522

@@ -6680,7 +6680,7 @@ not line breaks.
66806680
<para>
66816681
This section describes the detailed format of each logical replication
66826682
message. These messages are either returned by the replication slot SQL
6683-
interface or are sent by a walsender. In the case of a walsender they are
6683+
interface or are sent by a walsender. In the case of a walsender, they are
66846684
encapsulated inside replication protocol WAL messages as described in
66856685
<xref linkend="protocol-replication"/>, and generally obey the same message
66866686
flow as physical replication.

‎doc/src/sgml/ref/alter_publication.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
5050
tables/schemas that were present in the publication will be removed. The
5151
<literal>ADD</literal> and <literal>DROP</literal> clauses will add and
5252
remove one or more tables/schemas from the publication. Note that adding
53-
tables/schemas to a publication that is already subscribed to will require a
53+
tables/schemas to a publication that is already subscribed to will require an
5454
<literal>ALTER SUBSCRIPTION ... REFRESH PUBLICATION</literal> action on the
5555
subscribing side in order to become effective.
5656
</para>
@@ -82,7 +82,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
8282
<para>
8383
Adding/Setting a table that is part of schema specified in
8484
<literal>ALL TABLES IN SCHEMA</literal>, adding/setting a schema to a
85-
publication that already has a table that is part of specified schema or
85+
publication that already has a table that is part of the specified schema or
8686
adding/setting a table to a publication that already has a table's schema as
8787
part of the specified schema is not supported.
8888
</para>

‎doc/src/sgml/ref/create_publication.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,9 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
131131

132132
<para>
133133
When a partitioned table is published via schema level publication, all
134-
of its existing and future partitions irrespective of it being from the
135-
publication schema or not are implicitly considered to be part of the
136-
publication. So, even operations that are performed directly on a
134+
of its existing and future partitions are implicitly considered to be part of the
135+
publication, regardless of whether they are from the publication schema or not.
136+
So, even operations that are performed directly on a
137137
partition are also published via publications that its ancestors are
138138
part of.
139139
</para>
@@ -195,7 +195,7 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
195195

196196
<para>
197197
If <literal>FOR TABLE</literal>, <literal>FOR ALL TABLES</literal> or
198-
<literal>FOR ALL TABLES IN SCHEMA</literal> is not specified, then the
198+
<literal>FOR ALL TABLES IN SCHEMA</literal> are not specified, then the
199199
publication starts out with an empty set of tables. That is useful if
200200
tables or schemas are to be added later.
201201
</para>

0 commit comments

Comments
 (0)