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

Commit 5676da2

Browse files
committed
Documentation spell checking and markup improvements
1 parent ed0b228 commit 5676da2

15 files changed

+86
-86
lines changed

doc/src/sgml/bloom.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,8 @@ CREATE INDEX
212212

213213
<para>
214214
An operator class for bloom indexes requires only a hash function for the
215-
indexed datatype and an equality operator for searching. This example
216-
shows the opclass definition for the <type>text</> data type:
215+
indexed data type and an equality operator for searching. This example
216+
shows the operator class definition for the <type>text</> data type:
217217
</para>
218218

219219
<programlisting>

doc/src/sgml/brin.sgml

+13-13
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,7 @@ typedef struct BrinOpcInfo
625625
</table>
626626

627627
<para>
628-
To write an operator class for a complex datatype which has values
628+
To write an operator class for a complex data type which has values
629629
included within another type, it's possible to use the inclusion support
630630
procedures alongside the corresponding operators, as shown
631631
in <xref linkend="brin-extensibility-inclusion-table">. It requires
@@ -774,16 +774,16 @@ typedef struct BrinOpcInfo
774774
Support procedure numbers 1-10 are reserved for the BRIN internal
775775
functions, so the SQL level functions start with number 11. Support
776776
function number 11 is the main function required to build the index.
777-
It should accept two arguments with the same datatype as the opclass,
778-
and return the union of them. The inclusion opclass can store union
779-
values with different datatypes if it is defined with the
777+
It should accept two arguments with the same data type as the operator class,
778+
and return the union of them. The inclusion operator class can store union
779+
values with different data types if it is defined with the
780780
<literal>STORAGE</> parameter. The return value of the union
781-
function should match the <literal>STORAGE</> datatype.
781+
function should match the <literal>STORAGE</> data type.
782782
</para>
783783

784784
<para>
785785
Support procedure numbers 12 and 14 are provided to support
786-
irregularities of built-in datatypes. Procedure number 12
786+
irregularities of built-in data types. Procedure number 12
787787
is used to support network addresses from different families which
788788
are not mergeable. Procedure number 14 is used to support
789789
empty ranges. Procedure number 13 is an optional but
@@ -794,17 +794,17 @@ typedef struct BrinOpcInfo
794794
</para>
795795

796796
<para>
797-
Both minmax and inclusion opclasses support cross-datatype
797+
Both minmax and inclusion operator classes support cross-data-type
798798
operators, though with these the dependencies become more complicated.
799-
The minmax opclass requires a full set of operators to be
800-
defined with both arguments having the same datatype. It allows
801-
additional datatypes to be supported by defining extra sets
802-
of operators. Inclusion opclass operator strategies are dependent
799+
The minmax operator class requires a full set of operators to be
800+
defined with both arguments having the same data type. It allows
801+
additional data types to be supported by defining extra sets
802+
of operators. Inclusion operator class operator strategies are dependent
803803
on another operator strategy as shown in
804804
<xref linkend="brin-extensibility-inclusion-table">, or the same
805805
operator strategy as themselves. They require the dependency
806-
operator to be defined with the <literal>STORAGE</> datatype as the
807-
left-hand-side argument and the other supported datatype to be the
806+
operator to be defined with the <literal>STORAGE</> data type as the
807+
left-hand-side argument and the other supported data type to be the
808808
right-hand-side argument of the supported operator. See
809809
<literal>float4_minmax_ops</> as an example of minmax, and
810810
<literal>box_inclusion_ops</> as an example of inclusion.

doc/src/sgml/config.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2006,7 +2006,7 @@ include_dir 'conf.d'
20062006
<literal>Gather</literal> node. Parallel workers are taken from the
20072007
pool of processes established by
20082008
<xref linkend="guc-max-worker-processes">. Note that the requested
2009-
number of workers may not actually be available at runtime. If this
2009+
number of workers may not actually be available at run time. If this
20102010
occurs, the plan will run with fewer workers than expected, which may
20112011
be inefficient. The default value is 2. Setting this value to 0
20122012
disables parallel query execution.

doc/src/sgml/ecpg.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -3782,7 +3782,7 @@ EXEC SQL GET DESCRIPTOR <replaceable>name</replaceable> VALUE <replaceable>num</
37823782
keywords are different. A Descriptor Area can also be manually built to
37833783
provide the input parameters for a query or a cursor and
37843784
<literal>USING SQL DESCRIPTOR <replaceable>name</replaceable></literal>
3785-
is the way to pass the input parameters into a parametrized query. The statement
3785+
is the way to pass the input parameters into a parameterized query. The statement
37863786
to build a named SQL Descriptor Area is below:
37873787
<programlisting>
37883788
EXEC SQL SET DESCRIPTOR <replaceable>name</replaceable> VALUE <replaceable>num</replaceable> <replaceable>field</replaceable> = :<replaceable>hostvar</replaceable>;
@@ -3917,7 +3917,7 @@ typedef struct sqlda_struct sqlda_t;
39173917
<term><literal>sqln</></term>
39183918
<listitem>
39193919
<para>
3920-
It contains the number of input parameters for a parametrized query in
3920+
It contains the number of input parameters for a parameterized query in
39213921
case it's passed into <command>OPEN</command>, <command>DECLARE</command> or
39223922
<command>EXECUTE</command> statements using the <literal>USING</literal>
39233923
keyword. In case it's used as output of <command>SELECT</command>,
@@ -8121,7 +8121,7 @@ if (*(int2 *)sqldata->sqlvar[i].sqlind != 0)
81218121
<listitem>
81228122
<para>
81238123
Type of the NULL indicator data. It's always SQLSMINT when returning data from the server.
8124-
When the <literal>SQLDA</literal> is used for a parametrized query, the data is treated
8124+
When the <literal>SQLDA</literal> is used for a parameterized query, the data is treated
81258125
according to the set type.
81268126
</para>
81278127
</listitem>

doc/src/sgml/func.sgml

+42-42
Original file line numberDiff line numberDiff line change
@@ -17100,7 +17100,7 @@ SELECT collation for ('foo' COLLATE "de_DE");
1710017100
</entry>
1710117101
<entry><type>record</type></entry>
1710217102
<entry>
17103-
Returns information about current controldata file state.
17103+
Returns information about current control file state.
1710417104
</entry>
1710517105
</row>
1710617106

@@ -17148,97 +17148,97 @@ SELECT collation for ('foo' COLLATE "de_DE");
1714817148
<tbody>
1714917149

1715017150
<row>
17151-
<entry>checkpoint_location</entry>
17151+
<entry><literal>checkpoint_location</literal></entry>
1715217152
<entry><type>pg_lsn</type></entry>
1715317153
</row>
1715417154

1715517155
<row>
17156-
<entry>prior_location</entry>
17156+
<entry><literal>prior_location</literal></entry>
1715717157
<entry><type>pg_lsn</type></entry>
1715817158
</row>
1715917159

1716017160
<row>
17161-
<entry>redo_location</entry>
17161+
<entry><literal>redo_location</literal></entry>
1716217162
<entry><type>pg_lsn</type></entry>
1716317163
</row>
1716417164

1716517165
<row>
17166-
<entry>redo_wal_file</entry>
17166+
<entry><literal>redo_wal_file</literal></entry>
1716717167
<entry><type>text</type></entry>
1716817168
</row>
1716917169

1717017170
<row>
17171-
<entry>timeline_id</entry>
17171+
<entry><literal>timeline_id</literal></entry>
1717217172
<entry><type>integer</type></entry>
1717317173
</row>
1717417174

1717517175
<row>
17176-
<entry>prev_timeline_id</entry>
17176+
<entry><literal>prev_timeline_id</literal></entry>
1717717177
<entry><type>integer</type></entry>
1717817178
</row>
1717917179

1718017180
<row>
17181-
<entry>full_page_writes</entry>
17181+
<entry><literal>full_page_writes</literal></entry>
1718217182
<entry><type>boolean</type></entry>
1718317183
</row>
1718417184

1718517185
<row>
17186-
<entry>next_xid</entry>
17186+
<entry><literal>next_xid</literal></entry>
1718717187
<entry><type>text</type></entry>
1718817188
</row>
1718917189

1719017190
<row>
17191-
<entry>next_oid</entry>
17191+
<entry><literal>next_oid</literal></entry>
1719217192
<entry><type>oid</type></entry>
1719317193
</row>
1719417194

1719517195
<row>
17196-
<entry>next_multixact_id</entry>
17196+
<entry><literal>next_multixact_id</literal></entry>
1719717197
<entry><type>xid</type></entry>
1719817198
</row>
1719917199

1720017200
<row>
17201-
<entry>next_multi_offset</entry>
17201+
<entry><literal>next_multi_offset</literal></entry>
1720217202
<entry><type>xid</type></entry>
1720317203
</row>
1720417204

1720517205
<row>
17206-
<entry>oldest_xid</entry>
17206+
<entry><literal>oldest_xid</literal></entry>
1720717207
<entry><type>xid</type></entry>
1720817208
</row>
1720917209

1721017210
<row>
17211-
<entry>oldest_xid_dbid</entry>
17211+
<entry><literal>oldest_xid_dbid</literal></entry>
1721217212
<entry><type>oid</type></entry>
1721317213
</row>
1721417214

1721517215
<row>
17216-
<entry>oldest_active_xid</entry>
17216+
<entry><literal>oldest_active_xid</literal></entry>
1721717217
<entry><type>xid</type></entry>
1721817218
</row>
1721917219

1722017220
<row>
17221-
<entry>oldest_multi_xid</entry>
17221+
<entry><literal>oldest_multi_xid</literal></entry>
1722217222
<entry><type>xid</type></entry>
1722317223
</row>
1722417224

1722517225
<row>
17226-
<entry>oldest_multi_dbid</entry>
17226+
<entry><literal>oldest_multi_dbid</literal></entry>
1722717227
<entry><type>oid</type></entry>
1722817228
</row>
1722917229

1723017230
<row>
17231-
<entry>oldest_commit_ts_xid</entry>
17231+
<entry><literal>oldest_commit_ts_xid</literal></entry>
1723217232
<entry><type>xid</type></entry>
1723317233
</row>
1723417234

1723517235
<row>
17236-
<entry>newest_commit_ts_xid</entry>
17236+
<entry><literal>newest_commit_ts_xid</literal></entry>
1723717237
<entry><type>xid</type></entry>
1723817238
</row>
1723917239

1724017240
<row>
17241-
<entry>checkpoint_time</entry>
17241+
<entry><literal>checkpoint_time</literal></entry>
1724217242
<entry><type>timestamp with time zone</type></entry>
1724317243
</row>
1724417244

@@ -17264,22 +17264,22 @@ SELECT collation for ('foo' COLLATE "de_DE");
1726417264
<tbody>
1726517265

1726617266
<row>
17267-
<entry>pg_control_version</entry>
17267+
<entry><literal>pg_control_version</literal></entry>
1726817268
<entry><type>integer</type></entry>
1726917269
</row>
1727017270

1727117271
<row>
17272-
<entry>catalog_version_no</entry>
17272+
<entry><literal>catalog_version_no</literal></entry>
1727317273
<entry><type>integer</type></entry>
1727417274
</row>
1727517275

1727617276
<row>
17277-
<entry>system_identifier</entry>
17277+
<entry><literal>system_identifier</literal></entry>
1727817278
<entry><type>bigint</type></entry>
1727917279
</row>
1728017280

1728117281
<row>
17282-
<entry>pg_control_last_modified</entry>
17282+
<entry><literal>pg_control_last_modified</literal></entry>
1728317283
<entry><type>timestamp with time zone</type></entry>
1728417284
</row>
1728517285

@@ -17305,67 +17305,67 @@ SELECT collation for ('foo' COLLATE "de_DE");
1730517305
<tbody>
1730617306

1730717307
<row>
17308-
<entry>max_data_alignment</entry>
17308+
<entry><literal>max_data_alignment</literal></entry>
1730917309
<entry><type>integer</type></entry>
1731017310
</row>
1731117311

1731217312
<row>
17313-
<entry>database_block_size</entry>
17313+
<entry><literal>database_block_size</literal></entry>
1731417314
<entry><type>integer</type></entry>
1731517315
</row>
1731617316

1731717317
<row>
17318-
<entry>blocks_per_segment</entry>
17318+
<entry><literal>blocks_per_segment</literal></entry>
1731917319
<entry><type>integer</type></entry>
1732017320
</row>
1732117321

1732217322
<row>
17323-
<entry>wal_block_size</entry>
17323+
<entry><literal>wal_block_size</literal></entry>
1732417324
<entry><type>integer</type></entry>
1732517325
</row>
1732617326

1732717327
<row>
17328-
<entry>bytes_per_wal_segment</entry>
17328+
<entry><literal>bytes_per_wal_segment</literal></entry>
1732917329
<entry><type>integer</type></entry>
1733017330
</row>
1733117331

1733217332
<row>
17333-
<entry>max_identifier_length</entry>
17333+
<entry><literal>max_identifier_length</literal></entry>
1733417334
<entry><type>integer</type></entry>
1733517335
</row>
1733617336

1733717337
<row>
17338-
<entry>max_index_columns</entry>
17338+
<entry><literal>max_index_columns</literal></entry>
1733917339
<entry><type>integer</type></entry>
1734017340
</row>
1734117341

1734217342
<row>
17343-
<entry>max_toast_chunk_size</entry>
17343+
<entry><literal>max_toast_chunk_size</literal></entry>
1734417344
<entry><type>integer</type></entry>
1734517345
</row>
1734617346

1734717347
<row>
17348-
<entry>large_object_chunk_size</entry>
17348+
<entry><literal>large_object_chunk_size</literal></entry>
1734917349
<entry><type>integer</type></entry>
1735017350
</row>
1735117351

1735217352
<row>
17353-
<entry>bigint_timestamps</entry>
17353+
<entry><literal>bigint_timestamps</literal></entry>
1735417354
<entry><type>boolean</type></entry>
1735517355
</row>
1735617356

1735717357
<row>
17358-
<entry>float4_pass_by_value</entry>
17358+
<entry><literal>float4_pass_by_value</literal></entry>
1735917359
<entry><type>boolean</type></entry>
1736017360
</row>
1736117361

1736217362
<row>
17363-
<entry>float8_pass_by_value</entry>
17363+
<entry><literal>float8_pass_by_value</literal></entry>
1736417364
<entry><type>boolean</type></entry>
1736517365
</row>
1736617366

1736717367
<row>
17368-
<entry>data_page_checksum_version</entry>
17368+
<entry><literal>data_page_checksum_version</literal></entry>
1736917369
<entry><type>integer</type></entry>
1737017370
</row>
1737117371

@@ -17391,27 +17391,27 @@ SELECT collation for ('foo' COLLATE "de_DE");
1739117391
<tbody>
1739217392

1739317393
<row>
17394-
<entry>min_recovery_end_location</entry>
17394+
<entry><literal>min_recovery_end_location</literal></entry>
1739517395
<entry><type>pg_lsn</type></entry>
1739617396
</row>
1739717397

1739817398
<row>
17399-
<entry>min_recovery_end_timeline</entry>
17399+
<entry><literal>min_recovery_end_timeline</literal></entry>
1740017400
<entry><type>integer</type></entry>
1740117401
</row>
1740217402

1740317403
<row>
17404-
<entry>backup_start_location</entry>
17404+
<entry><literal>backup_start_location</literal></entry>
1740517405
<entry><type>pg_lsn</type></entry>
1740617406
</row>
1740717407

1740817408
<row>
17409-
<entry>backup_end_location</entry>
17409+
<entry><literal>backup_end_location</literal></entry>
1741017410
<entry><type>pg_lsn</type></entry>
1741117411
</row>
1741217412

1741317413
<row>
17414-
<entry>end_of_backup_record_required</entry>
17414+
<entry><literal>end_of_backup_record_required</literal></entry>
1741517415
<entry><type>boolean</type></entry>
1741617416
</row>
1741717417

doc/src/sgml/high-availability.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1046,7 +1046,7 @@ primary_slot_name = 'node_a_slot'
10461046
servers. Waiting for confirmation increases the user's confidence that the
10471047
changes will not be lost in the event of server crashes but it also
10481048
necessarily increases the response time for the requesting transaction.
1049-
The minimum wait time is the roundtrip time between primary to standby.
1049+
The minimum wait time is the round-trip time between primary to standby.
10501050
</para>
10511051

10521052
<para>

doc/src/sgml/indices.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1315,7 +1315,7 @@ SELECT target FROM tests WHERE subject = 'some-subject' AND success;
13151315
But there's a problem: the <literal>WHERE</> clause refers
13161316
to <literal>success</> which is not available as a result column of the
13171317
index. Nonetheless, an index-only scan is possible because the plan does
1318-
not need to recheck that part of the <literal>WHERE</> clause at runtime:
1318+
not need to recheck that part of the <literal>WHERE</> clause at run time:
13191319
all entries found in the index necessarily have <literal>success = true</>
13201320
so this need not be explicitly checked in the
13211321
plan. <productname>PostgreSQL</> versions 9.6 and later will recognize

0 commit comments

Comments
 (0)