Re: Add id's to various elements in protocol.sgml - Mailing list pgsql-hackers

From Brar Piening
Subject Re: Add id's to various elements in protocol.sgml
Date
Msg-id 1c846e8e-bb4f-1a2a-9b76-562a39ef78b5@gmx.de
Whole thread Raw
In response to Re: Add id's to various elements in protocol.sgml  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
Responses Re: Add id's to various elements in protocol.sgml
List pgsql-hackers
On Dec 14, 2021 at 20:47, Alvaro Herrera wrote:
>
> Hmm, I think we tend to avoid xreflabels; see
> https://www.postgresql.org/message-id/8315c0ca-7758-8823-fcb6-f37f9413e6b6@2ndquadrant.com

Ok, thank you for the hint.
I added them because <varlistentry> doesn't automatically generate
labels and they were present in the current docs for
CREATE_REPLICATION_SLOT
(https://github.com/postgres/postgres/blob/22bd3cbe0c284758d7174321f5596763095cdd55/doc/src/sgml/protocol.sgml#L1944).

After reading the aforementioned thread to
https://www.postgresql.org/message-id/20200611223836.GA2507%40momjian.us
I infer the following conclusions:
a) Do *not* include xreflabel for elements that get numbered.
b) There should be some general utility for the xreflabel, not just the
linking needs of one particular source location.
c) Generally, xreflabels are a bit of antipattern, so there need to be
solid arguments in favor of adding more.

Since I can't argue towards some general utility for the xreflabels and
don't have any other solid argument in favor of adding more, I will
remove them from my current patch but leave the existing ones intact.

Objections?






pgsql-hackers by date:

Previous
From: Juan José Santamaría Flecha
Date:
Subject: Re: Windows default locale vs initdb
Next
From: Shay Rojansky
Date:
Subject: Privilege required for IF EXISTS event if the object already exists