Thread: Fix incorrect UUID index entry in function documentation
Hi,
Both the UUID data type and UUID functions pages define an index entry
for "UUID" that points to the data type section. As a result, the index
includes two identical entries linking to the UUID type docs,
which seems strange.
I believe the UUID functions page should instead define its own index
entry that links to itself. Currently, the indexterm is written as:
--------------------
<sect1 id="functions-uuid">
<title>UUID Functions</title>
<indexterm zone="datatype-uuid">
<primary>UUID</primary>
<secondary>generating</secondary>
</indexterm>
--------------------
I suspect that "datatype-uuid" is a copy-paste error and should be
"functions-uuid" to reflect the correct section. The attached patch
updates this accordingly.
Thoughts?
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
Attachment
On Fri, Jun 20, 2025 at 11:33 PM Fujii Masao <masao.fujii@oss.nttdata.com> wrote: > > Hi, > > Both the UUID data type and UUID functions pages define an index entry > for "UUID" that points to the data type section. As a result, the index > includes two identical entries linking to the UUID type docs, > which seems strange. > > I believe the UUID functions page should instead define its own index > entry that links to itself. Currently, the indexterm is written as: > > -------------------- > <sect1 id="functions-uuid"> > <title>UUID Functions</title> > > <indexterm zone="datatype-uuid"> > <primary>UUID</primary> > <secondary>generating</secondary> > </indexterm> > -------------------- > > I suspect that "datatype-uuid" is a copy-paste error and should be > "functions-uuid" to reflect the correct section. The attached patch > updates this accordingly. > > Thoughts? +1. I think it also makes sense that "UUID generating" has the link to "UUID Functions". Regards, -- Masahiko Sawada Amazon Web Services: https://aws.amazon.com
On 2025/06/21 9:55, Masahiko Sawada wrote: > On Fri, Jun 20, 2025 at 11:33 PM Fujii Masao > <masao.fujii@oss.nttdata.com> wrote: >> >> Hi, >> >> Both the UUID data type and UUID functions pages define an index entry >> for "UUID" that points to the data type section. As a result, the index >> includes two identical entries linking to the UUID type docs, >> which seems strange. >> >> I believe the UUID functions page should instead define its own index >> entry that links to itself. Currently, the indexterm is written as: >> >> -------------------- >> <sect1 id="functions-uuid"> >> <title>UUID Functions</title> >> >> <indexterm zone="datatype-uuid"> >> <primary>UUID</primary> >> <secondary>generating</secondary> >> </indexterm> >> -------------------- >> >> I suspect that "datatype-uuid" is a copy-paste error and should be >> "functions-uuid" to reflect the correct section. The attached patch >> updates this accordingly. >> >> Thoughts? > > +1. I think it also makes sense that "UUID generating" has the link to > "UUID Functions". Yes, and the proposed change ensures that as well. So barring any objections, I will commit the patch. Regards, -- Fujii Masao NTT DATA Japan Corporation
> On 23 Jun 2025, at 16:40, Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
> So barring any objections, I will commit the patch.
+1, LGTM. There is one more occurrence though, the relnotes seem to need the
same treatment as they talk about UUID functions and not the UUID datatype:
diff --git a/doc/src/sgml/release-18.sgml b/doc/src/sgml/release-18.sgml
index 662c7d8890f..fba01d3ca44 100644
--- a/doc/src/sgml/release-18.sgml
+++ b/doc/src/sgml/release-18.sgml
@@ -2498,7 +2498,7 @@ Author: Masahiko Sawada <msawada@postgresql.org>
<listitem>
<para>
- Add <link linkend="datatype-uuid"><type>UUID</type></link>
+ Add <link linkend="functions-uuid"><type>UUID</type></link>
version 7 generation function <link
linkend="func_uuid_gen_table"><function>uuidv7()</function></link>
(Andrey Borodin)
--
Daniel Gustafsson
On 2025/06/23 23:52, Daniel Gustafsson wrote: >> On 23 Jun 2025, at 16:40, Fujii Masao <masao.fujii@oss.nttdata.com> wrote: > >> So barring any objections, I will commit the patch. > > +1, LGTM. Thanks for the review! > There is one more occurrence though, the relnotes seem to need the > same treatment as they talk about UUID functions and not the UUID datatype: > > diff --git a/doc/src/sgml/release-18.sgml b/doc/src/sgml/release-18.sgml > index 662c7d8890f..fba01d3ca44 100644 > --- a/doc/src/sgml/release-18.sgml > +++ b/doc/src/sgml/release-18.sgml > @@ -2498,7 +2498,7 @@ Author: Masahiko Sawada <msawada@postgresql.org> > > <listitem> > <para> > - Add <link linkend="datatype-uuid"><type>UUID</type></link> > + Add <link linkend="functions-uuid"><type>UUID</type></link> > version 7 generation function <link > linkend="func_uuid_gen_table"><function>uuidv7()</function></link> > (Andrey Borodin) That "UUID" here seems to refer to the general concept, so I don't think it needs to link specifically to the UUID functions page. Since the UUID data type page already provides a basic explanation, it makes sense for the link to point there. Also, since "uuidv7()" and "uuidv4()" there already link to the UUID functions page, that seems sufficient to me. Thought? Regards, -- Fujii Masao NTT DATA Japan Corporation
On 2025/06/24 0:46, Fujii Masao wrote: > > > On 2025/06/23 23:52, Daniel Gustafsson wrote: >>> On 23 Jun 2025, at 16:40, Fujii Masao <masao.fujii@oss.nttdata.com> wrote: >> >>> So barring any objections, I will commit the patch. >> >> +1, LGTM. > > Thanks for the review! > >> There is one more occurrence though, the relnotes seem to need the >> same treatment as they talk about UUID functions and not the UUID datatype: >> >> diff --git a/doc/src/sgml/release-18.sgml b/doc/src/sgml/release-18.sgml >> index 662c7d8890f..fba01d3ca44 100644 >> --- a/doc/src/sgml/release-18.sgml >> +++ b/doc/src/sgml/release-18.sgml >> @@ -2498,7 +2498,7 @@ Author: Masahiko Sawada <msawada@postgresql.org> >> >> <listitem> >> <para> >> - Add <link linkend="datatype-uuid"><type>UUID</type></link> >> + Add <link linkend="functions-uuid"><type>UUID</type></link> >> version 7 generation function <link >> linkend="func_uuid_gen_table"><function>uuidv7()</function></link> >> (Andrey Borodin) > > That "UUID" here seems to refer to the general concept, so I don't think > it needs to link specifically to the UUID functions page. Since the UUID > data type page already provides a basic explanation, it makes sense for > the link to point there. Also, since "uuidv7()" and "uuidv4()" there > already link to the UUID functions page, that seems sufficient to me. > Thought? I've committed the proposed patch first. If we later agree to change this part as well, we can commit that separately. Regards, -- Fujii Masao NTT DATA Japan Corporation
> On 24 Jun 2025, at 07:37, Fujii Masao <masao.fujii@oss.nttdata.com> wrote: > I've committed the proposed patch first. If we later agree to change > this part as well, we can commit that separately. What you committed is perfectly fine, thanks! -- Daniel Gustafsson