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 0ec9ded2-ea33-61a1-66e1-11e3b66b8f23@gmx.de
Whole thread Raw
In response to Re: Add id's to various elements in protocol.sgml  (Peter Eisentraut <peter.eisentraut@enterprisedb.com>)
Responses Re: Add id's to various elements in protocol.sgml
Re: Add id's to various elements in protocol.sgml
List pgsql-hackers
On Dec 17, 2021 at 08:13, Peter Eisentraut wrote:
> On 15.12.21 16:59, Brar Piening wrote:
>> On Dec 15, 2021 at 15:49, Alvaro Herrera wrote:
>>> On 2021-Dec-15, Brar Piening wrote:
>>>> 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.
>>> Yeah, I think not adding them until we have a use for them might be
>>> wisest.
>> A new version of the patch that doesn't add xreflabels is attached.
>
> Now this patch adds a bunch of ids, but you can't use them to link to,
> because as soon as you do, you will get complaints about a missing
> xreflabel.  So what is the remaining purpose?

The purpose is that you can directly link to the id in the public html
docs which still gets generated (e. g.
https://www.postgresql.org/docs/14/protocol-replication.html#PROTOCOL-REPLICATION-BASE-BACKUP).

Essentially it gives people discussing the protocol and pointing to a
certain command or message format the chance to link to the very thing
they are discussing instead of the top of the lengthy html page.





pgsql-hackers by date:

Previous
From: Tom Lane
Date:
Subject: Re: WIP: WAL prefetch (another approach)
Next
From: Greg Stark
Date:
Subject: Re: WIP: WAL prefetch (another approach)