Horton

Re: pgsql: Doc: add XML ID attributes to <sectN> and <varlistentry> tags.

Peter Eisentraut <peter.eisentraut@enterprisedb.com>

View thread View on postgr.es
From: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Brar Piening <brar@gmx.de>, pgsql-hackers@lists.postgresql.org
Date: 2023-01-16T11:12:10Z
Lists: pgsql-hackers 
On 12.01.23 00:05, Tom Lane wrote:
> 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">

should be fixed

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

I think we can leave these.  They are internally consistent.

> pgbuffercache.sgml:  <table id="pgbuffercache_summary-columns">

should be fixed

> ref/pg_checksums.sgml: <refsect1 id="r1-app-pg_checksums-1">

pretty bogus

Commits

  1. Doc: fix a few oddly-spelled SGML ID attributes.

  2. Doc: add XML ID attributes to <sectN> and <varlistentry> tags.