pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Brar Piening <brar@gmx.de>
To: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
Cc: pgsql-hackers@lists.postgresql.org
Subject: Re: pgsql: Doc: add XML ID attributes to <sectN> and <varlistentry> tags.
Date: Thu, 12 Jan 2023 06:34:44 +0100
Message-ID: <ccea6e06-83d9-8fc5-7b60-1a26e21ba549@gmx.de> (raw)
In-Reply-To: <769446.1673478332@sss.pgh.pa.us>
References: <E1pEyRa-002rhZ-B4@gemulon.postgresql.org>
	<56f62f5e-86d6-70d0-2d5a-49e1480e3c0b@enterprisedb.com>
	<769446.1673478332@sss.pgh.pa.us>

On 12.01.2023 at 00:05, Tom Lane wrote:
> Peter Eisentraut <peter.eisentraut@enterprisedb.com> writes:
>> Any reason the new ids in create_database.sgml deviate from the normal
>> naming schemes used everywhere else?  Is it to preserve the existing
>> create-database-strategy?  Maybe we should rename that one and make the
>> new ones consistent?

I don't remember every single choice I made but the general goal was to
at least stay consistent within a varlist/[sub]section/file/chapter and
*never* change pre-existing ids since somebody may already be pointing
to them.

After all it is just an identifier that is supposed to be unique and
should not hurt our aesthetic feelings too much.

The consistency is mostly because we tend to like it and maybe also to
avoid collisions when making up new ids but I doubt that anybody will
ever try to remember an id or infer one form knowledge about the thing
it should be pointing at. I consider it a pretty opaque string that is
meant for copy-paste from a browser to some editing window.

It is all in our head and as a matter of fact we could be using UUIDs as
Ids and save us from any further consistency issues. It's just that they
look so ugly.

> You'd have to ask Brar that, I didn't question his choices too much.
>
> I have no objection to changing things as you suggest.I'm hesitant to
> rename very many pre-existing IDs for fear of breaking peoples' bookmarks,
> but changing create-database-strategy doesn't seem like a big deal.

Personally I'd only d this for ids that haven't been "released" as
official documentation (even as "devel" since the new things tend to
attract more discussions and probably linking). I very much consider
URLs as UI and go long ways to keep them consistent (HTTP 3xx is a
friend of mine) as you never know who might be pointing at them from
where and making them a moving target defeats their purpose and probably
hurt more than some inconsistency.

Regards,

Brar






view thread (6+ messages)  latest in thread

Message-ID: <ccea6e06-83d9-8fc5-7b60-1a26e21ba549@gmx.de>
Permalink:  ../ccea6e06-83d9-8fc5-7b60-1a26e21ba549@gmx.de/
Also on:    postgresql.org/message-id/ccea6e06-83d9-8fc5-7b60-1a26e21ba549@gmx.de

 · 

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 from your mail client; the link fills in
  the headers below: reply via email
  Some clients, webmail especially, drop In-Reply-To and References from
  a link, and the reply then starts a new thread: use the mbox below.

  To: pgsql-committers@postgresql.org
  Cc: brar@gmx.de, tgl@sss.pgh.pa.us, peter.eisentraut@enterprisedb.com, pgsql-hackers@lists.postgresql.org
  Subject: Re: pgsql: Doc: add XML ID attributes to <sectN> and <varlistentry> tags.
  In-Reply-To: <ccea6e06-83d9-8fc5-7b60-1a26e21ba549@gmx.de>
  References: <E1pEyRa-002rhZ-B4@gemulon.postgresql.org> <56f62f5e-86d6-70d0-2d5a-49e1480e3c0b@enterprisedb.com> <769446.1673478332@sss.pgh.pa.us> <ccea6e06-83d9-8fc5-7b60-1a26e21ba549@gmx.de>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox