Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit36d1a84

Browse files
committed
Doc: fix minor issues in GiST support function documentation.
gist.sgml and xindex.sgml hadn't been fully updated for theaddition of a sortsupport support function (commit16fa9b2).xindex.sgml also missed that the compress and decompress supportfunctions are optional, an apparently far older oversight.In passing, fix gratuitous inconsistencies in wording andcapitalization.Noted by E. Rogov. Back-patch to v14; the residual issuesbefore that aren't significant enough to bother with.Discussion:https://postgr.es/m/163335322905.12519.5711557029494638051@wrigleys.postgresql.org
1 parent7111e33 commit36d1a84

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

‎doc/src/sgml/gist.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
272272

273273
<para>
274274
There are five methods that an index operator class for
275-
<acronym>GiST</acronym> must provide, andfive that are optional.
275+
<acronym>GiST</acronym> must provide, andsix that are optional.
276276
Correctness of the index is ensured
277277
by proper implementation of the <function>same</function>, <function>consistent</function>
278278
and <function>union</function> methods, while efficiency (size and speed) of the
@@ -291,9 +291,9 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
291291
searches). The optional ninth method <function>fetch</function> is needed if the
292292
operator class wishes to support index-only scans, except when the
293293
<function>compress</function> method is omitted. The optional tenth method
294-
<function>options</function> is needed if the operator classprovides
295-
theuser-specified parameters.
296-
The <function>sortsupport</function> method is also optional and is used to
294+
<function>options</function> is needed if the operator classhas
295+
user-specified parameters.
296+
Theoptional eleventh method<function>sortsupport</function> is used to
297297
speed up building a <acronym>GiST</acronym> index.
298298
</para>
299299

‎doc/src/sgml/xindex.sgml

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@
459459
</row>
460460
<row>
461461
<entry>
462-
Defines a set of options that are specific to this operator class
462+
Define options that are specific to this operator class
463463
(optional)
464464
</entry>
465465
<entry>5</entry>
@@ -501,7 +501,7 @@
501501
</row>
502502
<row>
503503
<entry>
504-
Defines a set of options that are specific to this operator class
504+
Define options that are specific to this operator class
505505
(optional)
506506
</entry>
507507
<entry>3</entry>
@@ -511,7 +511,7 @@
511511
</table>
512512

513513
<para>
514-
GiST indexes haveten support functions,three of which are optional,
514+
GiST indexes haveeleven support functions,six of which are optional,
515515
as shown in <xref linkend="xindex-gist-support-table"/>.
516516
(For more information see <xref linkend="gist"/>.)
517517
</para>
@@ -544,13 +544,13 @@
544544
<row>
545545
<entry><function>compress</function></entry>
546546
<entry>compute a compressed representation of a key or value
547-
to be indexed</entry>
547+
to be indexed (optional)</entry>
548548
<entry>3</entry>
549549
</row>
550550
<row>
551551
<entry><function>decompress</function></entry>
552552
<entry>compute a decompressed representation of a
553-
compressed key</entry>
553+
compressed key (optional)</entry>
554554
<entry>4</entry>
555555
</row>
556556
<row>
@@ -566,7 +566,7 @@
566566
<entry>6</entry>
567567
</row>
568568
<row>
569-
<entry><function>equal</function></entry>
569+
<entry><function>same</function></entry>
570570
<entry>compare two keys and return true if they are equal</entry>
571571
<entry>7</entry>
572572
</row>
@@ -583,12 +583,16 @@
583583
</row>
584584
<row>
585585
<entry><function>options</function></entry>
586-
<entry>
587-
Defines a set of options that are specific to this operator class
588-
(optional)
589-
</entry>
586+
<entry>define options that are specific to this operator class
587+
(optional)</entry>
590588
<entry>10</entry>
591589
</row>
590+
<row>
591+
<entry><function>sortsupport</function></entry>
592+
<entry>provide a sort comparator to be used in fast index builds
593+
(optional)</entry>
594+
<entry>11</entry>
595+
</row>
592596
</tbody>
593597
</tgroup>
594598
</table>
@@ -642,10 +646,8 @@
642646
</row>
643647
<row>
644648
<entry><function>options</function></entry>
645-
<entry>
646-
Defines a set of options that are specific to this operator class
647-
(optional)
648-
</entry>
649+
<entry>define options that are specific to this operator class
650+
(optional)</entry>
649651
<entry>6</entry>
650652
</row>
651653
</tbody>
@@ -720,7 +722,7 @@
720722
<row>
721723
<entry><function>options</function></entry>
722724
<entry>
723-
Defines a set of options that are specific to this operator class
725+
define options that are specific to this operator class
724726
(optional)
725727
</entry>
726728
<entry>7</entry>
@@ -778,7 +780,7 @@
778780
<row>
779781
<entry><function>options</function></entry>
780782
<entry>
781-
Defines a set of options that are specific to this operator class
783+
define options that are specific to this operator class
782784
(optional)
783785
</entry>
784786
<entry>5</entry>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp