public inbox for [email protected]  
help / color / mirror / Atom feed
From: Brar Piening <[email protected]>
To: Peter Eisentraut <[email protected]>
To: Alvaro Herrera <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Subject: Re: Add id's to various elements in protocol.sgml
Date: Sat, 18 Dec 2021 00:53:54 +0100
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>

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.







view thread (11+ messages)  latest in thread

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: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Add id's to various elements in protocol.sgml
  In-Reply-To: <[email protected]>

* 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