Doc: fix minor issues in GiST support function documentation.

gist.sgml and xindex.sgml hadn't been fully updated for the
addition of a sortsupport support function (commit 16fa9b2b3).
xindex.sgml also missed that the compress and decompress support
functions are optional, an apparently far older oversight.

In passing, fix gratuitous inconsistencies in wording and
capitalization.

Noted by E. Rogov.  Back-patch to v14; the residual issues
before that aren't significant enough to bother with.

Discussion: https://postgr.es/m/163335322905.12519.5711557029494638051@wrigleys.postgresql.org

diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index c79ce850e9463ccb7dcfc4d0837c0eec97d98ad9..9ac6b03e6e4524006862b6ab27b3cac6b345a50d 100644 (file)
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -272,7 +272,7 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
 
  
    There are five methods that an index operator class for
-   GiST must provide, and five that are optional.
+   GiST must provide, and six that are optional.
    Correctness of the index is ensured
    by proper implementation of the same, consistent
    and union methods, while efficiency (size and speed) of the
@@ -291,9 +291,9 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
    searches). The optional ninth method fetch is needed if the
    operator class wishes to support index-only scans, except when the
    compress method is omitted. The optional tenth method
-   options is needed if the operator class provides
-   the user-specified parameters.
-   The sortsupport method is also optional and is used to
+   options is needed if the operator class has
+   user-specified parameters.
+   The optional eleventh method sortsupport is used to
    speed up building a GiST index.
  
 

diff --git a/doc/src/sgml/xindex.sgml b/doc/src/sgml/xindex.sgml
index 0a4fe9a776ab589e2b3861c941a5298b15ecec88..c753d8005acd49e0f07fd3cb0f5b984338646e3b 100644 (file)
--- a/doc/src/sgml/xindex.sgml
+++ b/doc/src/sgml/xindex.sgml
@@ -459,7 +459,7 @@
       
       
        
-        Defines a set of options that are specific to this operator class
+        Define options that are specific to this operator class
         (optional)
        
        5
@@ -501,7 +501,7 @@
       
       
        
-        Defines a set of options that are specific to this operator class
+        Define options that are specific to this operator class
         (optional)
        
        3
@@ -511,7 +511,7 @@
    
 
   
-   GiST indexes have ten support functions, three of which are optional,
+   GiST indexes have eleven support functions, six of which are optional,
    as shown in .
    (For more information see .)
   
@@ -544,13 +544,13 @@
       
        compress
        compute a compressed representation of a key or value
-        to be indexed
+        to be indexed (optional)
        3
       
       
        decompress
        compute a decompressed representation of a
-        compressed key
+        compressed key (optional)
        4
       
       
@@ -566,7 +566,7 @@
        6
       
       
-       equal
+       same
        compare two keys and return true if they are equal
        7
       
@@ -583,12 +583,16 @@
       
       
        options
-       
-        Defines a set of options that are specific to this operator class
-        (optional)
-       
+       define options that are specific to this operator class
+        (optional)
        10
       
+      
+       sortsupport
+       provide a sort comparator to be used in fast index builds
+        (optional)
+       11
+      
      
     
    
@@ -642,10 +646,8 @@
       
       
        options
-       
-        Defines a set of options that are specific to this operator class
-        (optional)
-       
+       define options that are specific to this operator class
+        (optional)
        6
       
      
@@ -720,7 +722,7 @@
       
        options
        
-        Defines a set of options that are specific to this operator class
+        define options that are specific to this operator class
         (optional)
        
        7
@@ -778,7 +780,7 @@
       
        options
        
-        Defines a set of options that are specific to this operator class
+        define options that are specific to this operator class
         (optional)
        
        5