Skip to content

Commit aa68872

Browse files
committed
doc: Spell checking
1 parent 1264ef3 commit aa68872

27 files changed

+87
-87
lines changed

doc/src/sgml/bgworker.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ typedef struct BackgroundWorker
6969
</para>
7070

7171
<para>
72-
<structfield>bgw_flags</> is a bitwise-or'd bitmask indicating the
72+
<structfield>bgw_flags</> is a bitwise-or'd bit mask indicating the
7373
capabilities that the module wants. Possible values are
7474
<literal>BGWORKER_SHMEM_ACCESS</literal> (requesting shared memory access)
7575
and <literal>BGWORKER_BACKEND_DATABASE_CONNECTION</literal> (requesting the
@@ -114,14 +114,14 @@ typedef struct BackgroundWorker
114114
passed at registration time. <structfield>bgw_main</structfield> may be
115115
NULL; in that case, <structfield>bgw_library_name</structfield> and
116116
<structfield>bgw_function_name</structfield> will be used to determine
117-
the entrypoint. This is useful for background workers launched after
117+
the entry point. This is useful for background workers launched after
118118
postmaster startup, where the postmaster does not have the requisite
119119
library loaded.
120120
</para>
121121

122122
<para>
123123
<structfield>bgw_library_name</structfield> is the name of a library in
124-
which the initial entrypoint for the background worker should be sought.
124+
which the initial entry point for the background worker should be sought.
125125
It is ignored unless <structfield>bgw_main</structfield> is NULL.
126126
But if <structfield>bgw_main</structfield> is NULL, then the named library
127127
will be dynamically loaded by the worker process and
@@ -131,7 +131,7 @@ typedef struct BackgroundWorker
131131

132132
<para>
133133
<structfield>bgw_function_name</structfield> is the name of a function in
134-
a dynamically loaded library which should be used as the initial entrypoint
134+
a dynamically loaded library which should be used as the initial entry point
135135
for a new background worker. It is ignored unless
136136
<structfield>bgw_main</structfield> is NULL.
137137
</para>

doc/src/sgml/catalogs.sgml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -408,13 +408,13 @@
408408
<entry><structfield>aggfinalextra</structfield></entry>
409409
<entry><type>bool</type></entry>
410410
<entry></entry>
411-
<entry>True to pass extra dummy arguments to aggfinalfn</entry>
411+
<entry>True to pass extra dummy arguments to <structfield>aggfinalfn</structfield></entry>
412412
</row>
413413
<row>
414414
<entry><structfield>aggmfinalextra</structfield></entry>
415415
<entry><type>bool</type></entry>
416416
<entry></entry>
417-
<entry>True to pass extra dummy arguments to aggmfinalfn</entry>
417+
<entry>True to pass extra dummy arguments to <structfield>aggmfinalfn</structfield></entry>
418418
</row>
419419
<row>
420420
<entry><structfield>aggsortop</structfield></entry>
@@ -838,7 +838,7 @@
838838
<entry><structfield>amopsortfamily</structfield></entry>
839839
<entry><type>oid</type></entry>
840840
<entry><literal><link linkend="catalog-pg-opfamily"><structname>pg_opfamily</structname></link>.oid</literal></entry>
841-
<entry>The btree operator family this entry sorts according to, if an
841+
<entry>The B-tree operator family this entry sorts according to, if an
842842
ordering operator; zero if a search operator</entry>
843843
</row>
844844

@@ -853,7 +853,7 @@
853853
<replaceable>indexed_column</>
854854
<replaceable>operator</>
855855
<replaceable>constant</>.
856-
Obviously, such an operator must return boolean, and its left-hand input
856+
Obviously, such an operator must return <type>boolean</type>, and its left-hand input
857857
type must match the index's column data type.
858858
</para>
859859

@@ -868,13 +868,13 @@
868868
its left-hand input type must match the index's column data type.
869869
The exact semantics of the <literal>ORDER BY</> are specified by the
870870
<structfield>amopsortfamily</structfield> column, which must reference
871-
a btree operator family for the operator's result type.
871+
a B-tree operator family for the operator's result type.
872872
</para>
873873

874874
<note>
875875
<para>
876876
At present, it's assumed that the sort order for an ordering operator
877-
is the default for the referenced opfamily, i.e., <literal>ASC NULLS
877+
is the default for the referenced operator family, i.e., <literal>ASC NULLS
878878
LAST</>. This might someday be relaxed by adding additional columns
879879
to specify sort options explicitly.
880880
</para>
@@ -974,7 +974,7 @@
974974
these match the input data type(s) of the support procedure itself, for
975975
others not. There is a notion of <quote>default</> support procedures for
976976
an index, which are those with <structfield>amproclefttype</> and
977-
<structfield>amprocrighttype</> both equal to the index opclass's
977+
<structfield>amprocrighttype</> both equal to the index operator class's
978978
<structfield>opcintype</>.
979979
</para>
980980

@@ -1959,7 +1959,7 @@
19591959
<literal>d</> = default (primary key, if any),
19601960
<literal>n</> = nothing,
19611961
<literal>f</> = all columns
1962-
<literal>i</> = index with indisreplident set, or default
1962+
<literal>i</> = index with <structfield>indisreplident</structfield> set, or default
19631963
</entry>
19641964
</row>
19651965

@@ -5261,7 +5261,7 @@
52615261
<entry><structfield>plugin</structfield></entry>
52625262
<entry><type>name</type></entry>
52635263
<entry></entry>
5264-
<entry>The basename of the shared object containing the output plugin this logical slot is using, or null for physical slots.</entry>
5264+
<entry>The base name of the shared object containing the output plugin this logical slot is using, or null for physical slots.</entry>
52655265
</row>
52665266

52675267
<row>
@@ -5275,7 +5275,7 @@
52755275
<entry><structfield>datoid</structfield></entry>
52765276
<entry><type>oid</type></entry>
52775277
<entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.oid</literal></entry>
5278-
<entry>The oid of the database this slot is associated with, or
5278+
<entry>The OID of the database this slot is associated with, or
52795279
null. Only logical slots have an associated database.</entry>
52805280
</row>
52815281

doc/src/sgml/config.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2603,7 +2603,7 @@ include_dir 'conf.d'
26032603
<para>
26042604
The name of a standby server for this purpose is the
26052605
<varname>application_name</> setting of the standby, as set in the
2606-
<varname>primary_conninfo</> of the standby's walreceiver. There is
2606+
<varname>primary_conninfo</> of the standby's WAL receiver. There is
26072607
no mechanism to enforce uniqueness. In case of duplicates one of the
26082608
matching standbys will be chosen to be the synchronous standby, though
26092609
exactly which one is indeterminate.

doc/src/sgml/datatype.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4487,7 +4487,7 @@ SELECT * FROM pg_attribute
44874487
<para>
44884488
The <type>pg_lsn</type> data type can be used to store LSN (Log Sequence
44894489
Number) data which is a pointer to a location in the XLOG. This type is a
4490-
representation of XLogRecPtr and an internal system type of
4490+
representation of <type>XLogRecPtr</type> and an internal system type of
44914491
<productname>PostgreSQL</productname>.
44924492
</para>
44934493

doc/src/sgml/fdwhandler.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ PlanForeignModify (PlannerInfo *root,
353353
<literal>plan</> is the <structname>ModifyTable</> plan node, which is
354354
complete except for the <structfield>fdwPrivLists</> field.
355355
<literal>resultRelation</> identifies the target foreign table by its
356-
rangetable index. <literal>subplan_index</> identifies which target of
356+
range table index. <literal>subplan_index</> identifies which target of
357357
the <structname>ModifyTable</> plan node this is, counting from zero;
358358
use this if you want to index into <literal>plan-&gt;plans</> or other
359359
substructure of the <literal>plan</> node.
@@ -430,7 +430,7 @@ ExecForeignInsert (EState *estate,
430430
<literal>rinfo</> is the <structname>ResultRelInfo</> struct describing
431431
the target foreign table.
432432
<literal>slot</> contains the tuple to be inserted; it will match the
433-
rowtype definition of the foreign table.
433+
row-type definition of the foreign table.
434434
<literal>planSlot</> contains the tuple that was generated by the
435435
<structname>ModifyTable</> plan node's subplan; it differs from
436436
<literal>slot</> in possibly containing additional <quote>junk</>
@@ -476,7 +476,7 @@ ExecForeignUpdate (EState *estate,
476476
<literal>rinfo</> is the <structname>ResultRelInfo</> struct describing
477477
the target foreign table.
478478
<literal>slot</> contains the new data for the tuple; it will match the
479-
rowtype definition of the foreign table.
479+
row-type definition of the foreign table.
480480
<literal>planSlot</> contains the tuple that was generated by the
481481
<structname>ModifyTable</> plan node's subplan; it differs from
482482
<literal>slot</> in possibly containing additional <quote>junk</>
@@ -576,7 +576,7 @@ IsForeignRelUpdatable (Relation rel);
576576
</programlisting>
577577

578578
Report which update operations the specified foreign table supports.
579-
The return value should be a bitmask of rule event numbers indicating
579+
The return value should be a bit mask of rule event numbers indicating
580580
which operations are supported by the foreign table, using the
581581
<literal>CmdType</> enumeration; that is,
582582
<literal>(1 << CMD_UPDATE) = 4</> for <command>UPDATE</>,

doc/src/sgml/func.sgml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10086,7 +10086,7 @@ table2-mapping
1008610086

1008710087
<para>
1008810088
<xref linkend="functions-json-op-table"> shows the operators that
10089-
are available for use with the two JSON datatypes (see <xref
10089+
are available for use with the two JSON data types (see <xref
1009010090
linkend="datatype-json">).
1009110091
</para>
1009210092

@@ -10162,7 +10162,7 @@ table2-mapping
1016210162
The standard comparison operators shown in <xref
1016310163
linkend="functions-comparison-table"> are available for
1016410164
<type>jsonb</type>, but not for <type>json</type>. They follow the
10165-
ordering rules for btree operations outlined at <xref
10165+
ordering rules for B-tree operations outlined at <xref
1016610166
linkend="json-indexing">.
1016710167
</para>
1016810168
<para>
@@ -10269,7 +10269,7 @@ table2-mapping
1026910269
(recursively) to arrays and objects; otherwise, if there is a cast
1027010270
from the type to <type>json</type>, the cast function will be used to
1027110271
perform the conversion; otherwise, a JSON scalar value is produced.
10272-
For any scalar type other than a number, a boolean, or a null value,
10272+
For any scalar type other than a number, a Boolean, or a null value,
1027310273
the text representation will be used, properly quoted and escaped
1027410274
so that it is a valid JSON string.
1027510275
</entry>
@@ -14007,7 +14007,7 @@ AND
1400714007
These operators compare the internal binary representation of the two
1400814008
rows. Two rows might have a different binary representation even
1400914009
though comparisons of the two rows with the equality operator is true.
14010-
The ordering of rows under these comparision operators is deterministic
14010+
The ordering of rows under these comparison operators is deterministic
1401114011
but not otherwise meaningful. These operators are used internally for
1401214012
materialized views and might be useful for other specialized purposes
1401314013
such as replication but are not intended to be generally useful for
@@ -15461,32 +15461,32 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
1546115461
<row>
1546215462
<entry><literal><function>to_regclass(<parameter>rel_name</parameter>)</function></literal></entry>
1546315463
<entry><type>regclass</type></entry>
15464-
<entry>get the oid of the named relation</entry>
15464+
<entry>get the OID of the named relation</entry>
1546515465
</row>
1546615466
<row>
1546715467
<entry><literal><function>to_regproc(<parameter>func_name</parameter>)</function></literal></entry>
1546815468
<entry><type>regproc</type></entry>
15469-
<entry>get the oid of the named function</entry>
15469+
<entry>get the OID of the named function</entry>
1547015470
</row>
1547115471
<row>
1547215472
<entry><literal><function>to_regprocedure(<parameter>func_name</parameter>)</function></literal></entry>
1547315473
<entry><type>regprocedure</type></entry>
15474-
<entry>get the oid of the named function</entry>
15474+
<entry>get the OID of the named function</entry>
1547515475
</row>
1547615476
<row>
1547715477
<entry><literal><function>to_regoper(<parameter>operator_name</parameter>)</function></literal></entry>
1547815478
<entry><type>regoper</type></entry>
15479-
<entry>get the oid of the named operator</entry>
15479+
<entry>get the OID of the named operator</entry>
1548015480
</row>
1548115481
<row>
1548215482
<entry><literal><function>to_regoperator(<parameter>operator_name</parameter>)</function></literal></entry>
1548315483
<entry><type>regoperator</type></entry>
15484-
<entry>get the oid of the named operator</entry>
15484+
<entry>get the OID of the named operator</entry>
1548515485
</row>
1548615486
<row>
1548715487
<entry><literal><function>to_regtype(<parameter>type_name</parameter>)</function></literal></entry>
1548815488
<entry><type>regtype</type></entry>
15489-
<entry>get the oid of the named type</entry>
15489+
<entry>get the OID of the named type</entry>
1549015490
</row>
1549115491
</tbody>
1549215492
</tgroup>
@@ -16619,8 +16619,8 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1661916619
<entry>
1662016620
Creates a new physical replication slot named
1662116621
<parameter>slot_name</parameter>. Streaming changes from a physical slot
16622-
is only possible with the walsender protocol - see <xref
16623-
linkend="protocol-replication">. Corresponds to the walsender protocol
16622+
is only possible with the streaming-replication protocol - see <xref
16623+
linkend="protocol-replication">. Corresponds to the replication protocol
1662416624
command <literal>CREATE_REPLICATION_SLOT ... PHYSICAL</literal>.
1662516625
</entry>
1662616626
</row>
@@ -16636,7 +16636,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1663616636
</entry>
1663716637
<entry>
1663816638
Drops the physical or logical replication slot
16639-
named <parameter>slot_name</parameter>. Same as walsender protocol
16639+
named <parameter>slot_name</parameter>. Same as replication protocol
1664016640
command <literal>DROP_REPLICATION_SLOT</>.
1664116641
</entry>
1664216642
</row>

doc/src/sgml/high-availability.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1894,7 +1894,7 @@ if (!triggered)
18941894
might want to make adjustments to handle the period when
18951895
<varname>hot_standby_feedback</> feedback is not being provided.
18961896
For example, consider increasing <varname>max_standby_archive_delay</>
1897-
so that queries are not rapidly cancelled by conflicts in WAL archive
1897+
so that queries are not rapidly canceled by conflicts in WAL archive
18981898
files during disconnected periods. You should also consider increasing
18991899
<varname>max_standby_streaming_delay</> to avoid rapid cancellations
19001900
by newly-arrived streaming WAL entries after reconnection.

doc/src/sgml/indexam.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ ambuild (Relation heapRelation,
168168
void
169169
ambuildempty (Relation indexRelation);
170170
</programlisting>
171-
Build an empty index, and write it to the initialization fork (INIT_FORKNUM)
171+
Build an empty index, and write it to the initialization fork (<symbol>INIT_FORKNUM</symbol>)
172172
of the given relation. This method is called only for unlogged tables; the
173173
empty index written to the initialization fork will be copied over the main
174174
relation fork on each server restart.
@@ -278,7 +278,7 @@ amcanreturn (Relation indexRelation);
278278
</programlisting>
279279
Check whether the index can support <firstterm>index-only scans</> by
280280
returning the indexed column values for an index entry in the form of an
281-
IndexTuple. Return TRUE if so, else FALSE. If the index AM can never
281+
<structname>IndexTuple</structname>. Return TRUE if so, else FALSE. If the index AM can never
282282
support index-only scans (an example is hash, which stores only
283283
the hash values not the original data), it is sufficient to set its
284284
<structfield>amcanreturn</> field to zero in <structname>pg_am</>.

doc/src/sgml/json.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ SELECT '"foo"'::jsonb ? 'foo';
354354
keys or key/value pairs occurring within a large number of
355355
<type>jsonb</> documents (datums).
356356
Two GIN <quote>operator classes</> are provided, offering different
357-
performance and flexibility tradeoffs.
357+
performance and flexibility trade-offs.
358358
</para>
359359
<para>
360360
The default GIN operator class for <type>jsonb</> supports queries with

doc/src/sgml/libpq.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ PGconn *PQconnectdbParams(const char * const *keywords,
136136
</para>
137137

138138
<para>
139-
If any parameter is NULL or an emptry string, the corresponding
139+
If any parameter is <symbol>NULL</symbol> or an emptry string, the corresponding
140140
environment variable (see <xref linkend="libpq-envars">) is checked.
141141
If the environment variable is not set either, then the indicated
142142
built-in defaults are used.

0 commit comments

Comments
 (0)