public inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feeddoc: Fix the header file where CompareType is defined in gist.sgml
3+ messages / 3 participants
[nested] [flat]
* doc: Fix the header file where CompareType is defined in gist.sgml
@ 2025-12-13 08:24 Daisuke Higuchi <higuchi.daisuke11@gmail.com>
0 siblings, 1 reply; 3+ messages in thread
From: Daisuke Higuchi @ 2025-12-13 08:24 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
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.
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: doc: Fix the header file where CompareType is defined in gist.sgml
@ 2025-12-15 23:19 Paul A Jungwirth <pj@illuminatedcomputing.com>
parent: Daisuke Higuchi <higuchi.daisuke11@gmail.com>
0 siblings, 1 reply; 3+ messages in thread
From: Paul A Jungwirth @ 2025-12-15 23:19 UTC (permalink / raw)
To: Daisuke Higuchi <higuchi.daisuke11@gmail.com>; +Cc: pgsql-docs@lists.postgresql.org
On Sat, Dec 13, 2025 at 12:25 AM Daisuke Higuchi
<higuchi.daisuke11@gmail.com> wrote:
>
> 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
You're right, that's where we define it. Your email landed in Gmail's
spam folder for me, so hopefully this +1 will help it not be missed by
a committer.
Yours,
--
Paul ~{:-)
pj@illuminatedcomputing.com
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: doc: Fix the header file where CompareType is defined in gist.sgml
@ 2025-12-16 08:50 Daniel Gustafsson <daniel@yesql.se>
parent: Paul A Jungwirth <pj@illuminatedcomputing.com>
0 siblings, 0 replies; 3+ messages in thread
From: Daniel Gustafsson @ 2025-12-16 08:50 UTC (permalink / raw)
To: Paul A Jungwirth <pj@illuminatedcomputing.com>; +Cc: Daisuke Higuchi <higuchi.daisuke11@gmail.com>; pgsql-docs@lists.postgresql.org
> On 16 Dec 2025, at 00:19, Paul A Jungwirth <pj@illuminatedcomputing.com> wrote:
>
> On Sat, Dec 13, 2025 at 12:25 AM Daisuke Higuchi
> <higuchi.daisuke11@gmail.com> wrote:
>>
>> 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
>
> You're right, that's where we define it. Your email landed in Gmail's
> spam folder for me, so hopefully this +1 will help it not be missed by
> a committer.
Thanks for the report, fixing it right now.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2025-12-16 08:50 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-12-13 08:24 doc: Fix the header file where CompareType is defined in gist.sgml Daisuke Higuchi <higuchi.daisuke11@gmail.com>
2025-12-15 23:19 ` Paul A Jungwirth <pj@illuminatedcomputing.com>
2025-12-16 08:50 ` Daniel Gustafsson <daniel@yesql.se>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox