Re: Adding xreflable - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Adding xreflable
Date
Msg-id 20200515134900.GD3894@momjian.us
Whole thread Raw
In response to Re: Adding xreflable  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Adding xreflable
List pgsql-docs
On Fri, May 15, 2020 at 09:37:30AM -0400, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > I have noticed that our ref/*.sgml pages don't have such labels.  I
> > would like to add them and use them for our release notes.  Some of our
> > extensions need them too.
> 
> Why?  Our convention generally is to refer to the command, not to the ref
> page as such.

Uh, for the release notes, I am referencing the doc page about the
feature, and without the xref, I have to mention it twice, e.g.:

     This allows efficient btree indexing of low cardinality columns
     by storing duplicate keys only once.  Users upgrading with <link
     linkend="pgupgrade"><application>pg_upgrade</application></link>
     will need to use <link
     linkend="sql-reindex"><command>REINDEX</command></link> to make use
     of this feature.

I am guessing I will have to put the <command> tags around the <xref>.
As you can see, pg_upgrade, is also missing an xreflabel.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EnterpriseDB                             https://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +



pgsql-docs by date:

Previous
From: Tom Lane
Date:
Subject: Re: Adding xreflable
Next
From: Tom Lane
Date:
Subject: Re: Adding xreflable