public inbox for pgsql-docs@postgresql.org  

help / color / mirror / Atom feed

From: Daisuke Higuchi <higuchi.daisuke11@gmail.com>
To: pgsql-docs@lists.postgresql.org
Subject: doc: Fix the header file where CompareType is defined in gist.sgml
Date: Sat, 13 Dec 2025 17:24:48 +0900
Message-ID: <CAEVT6c8guXe5P=L_Un5NUUzCgEgbHnNcP+Y3TV2WbQh-xjiwqA@mail.gmail.com> (raw)

Hi

I found that the header file where CompareType was actually defined did not
match the header file described in gist.sgml.
CompareType is currently defined at "src/include/access/cmptype.h" instead
of "src/include/nodes/primnodes.h".
This change was made in the commit below, but it seems that documentation
update was missed.

https://github.com/postgres/postgres/commit/119fc30dd5bd918819b864107ddc8baac51f4d22

Regards


Attachments:

  [application/octet-stream] gist_doc.patch (1.2K, 3-gist_doc.patch)
  download | inline diff:
diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index 5cbea8c3d55..1871f742721 100644
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -291,7 +291,7 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
    speed up building a <acronym>GiST</acronym> index.
    The optional twelfth method <function>stratnum</function> is used to
    translate compare types (from
-   <filename>src/include/nodes/primnodes.h</filename>) into strategy numbers
+   <filename>src/include/access/cmptype.h</filename>) into strategy numbers
    used by the operator class.  This lets the core code look up operators for
    temporal constraint indexes.
  </para>
@@ -1174,7 +1174,7 @@ my_sortsupport(PG_FUNCTION_ARGS)
      <listitem>
       <para>
        Given a <literal>CompareType</literal> value from
-       <filename>src/include/nodes/primnodes.h</filename>, returns a strategy
+       <filename>src/include/access/cmptype.h</filename>, returns a strategy
        number used by this operator class for matching functionality.  The
        function should return <literal>InvalidStrategy</literal> if the
        operator class has no matching strategy.

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: higuchi.daisuke11@gmail.com, pgsql-docs@lists.postgresql.org
  Subject: Re: doc: Fix the header file where CompareType is defined in gist.sgml
  In-Reply-To: <CAEVT6c8guXe5P=L_Un5NUUzCgEgbHnNcP+Y3TV2WbQh-xjiwqA@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox