pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
Cc: Brar Piening <brar@gmx.de>
Cc: pgsql-hackers@lists.postgresql.org
Subject: Re: pgsql: Doc: add XML ID attributes to <sectN> and <varlistentry> tags.
Date: Wed, 11 Jan 2023 18:05:32 -0500
Message-ID: <769446.1673478332@sss.pgh.pa.us> (raw)
In-Reply-To: <56f62f5e-86d6-70d0-2d5a-49e1480e3c0b@enterprisedb.com>
References: <E1pEyRa-002rhZ-B4@gemulon.postgresql.org>
	<56f62f5e-86d6-70d0-2d5a-49e1480e3c0b@enterprisedb.com>

Peter Eisentraut <peter.eisentraut@enterprisedb.com> writes:
> On 09.01.23 21:08, Tom Lane wrote:
>> Doc: add XML ID attributes to <sectN> and <varlistentry> tags.

> 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?

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.

That reminds me that I was going to suggest fixing the few existing
variances from the "use '-' not '_'" policy:

$ grep 'id="[a-zA-Z0-9-]*_' *sgml ref/*sgml
config.sgml:     <varlistentry id="guc-plan-cache_mode" xreflabel="plan_cache_mode">
libpq.sgml:        <varlistentry id="libpq-PQpingParams-PQPING_OK">
libpq.sgml:        <varlistentry id="libpq-PQpingParams-PQPING_REJECT">
libpq.sgml:        <varlistentry id="libpq-PQpingParams-PQPING_NO_RESPONSE">
libpq.sgml:        <varlistentry id="libpq-PQpingParams-PQPING_NO_ATTEMPT">
pgbuffercache.sgml:  <table id="pgbuffercache_summary-columns">
ref/pg_checksums.sgml: <refsect1 id="r1-app-pg_checksums-1">

As you say, this isn't required by the toolchain any longer, but it
seems like a good idea to have consistent tag spelling.  I'm particularly
annoyed by guc-plan-cache_mode, which isn't even consistent with itself
let alone every other guc-XXX tag.

			regards, tom lane





view thread (6+ messages)  latest in thread

Message-ID: <769446.1673478332@sss.pgh.pa.us>
Permalink:  ../769446.1673478332@sss.pgh.pa.us/
Also on:    postgresql.org/message-id/769446.1673478332@sss.pgh.pa.us

 · 

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: tgl@sss.pgh.pa.us, peter.eisentraut@enterprisedb.com, brar@gmx.de, pgsql-hackers@lists.postgresql.org
  Subject: Re: pgsql: Doc: add XML ID attributes to <sectN> and <varlistentry> tags.
  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>

* 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