varname for GUC variables

Started by Bruce Momjianabout 15 years ago3 messagesdocs
Jump to latest
#1Bruce Momjian
bruce@momjian.us

I have applied the attached patch to use <varname> SGML markup
consistently for GUC variables. Should we be using <xref> to link to
more GUC details in the docs? E.g., change:

<varname>standard_conforming_strings</>

to:

<xref linkend="guc-standard-conforming-strings">

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

+ It's impossible for everything to be true. +

Attachments:

/rtmp/varname.difftext/x-diffDownload+120-120
#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#1)
Re: varname for GUC variables

Bruce Momjian <bruce@momjian.us> writes:

I have applied the attached patch to use <varname> SGML markup
consistently for GUC variables. Should we be using <xref> to link to
more GUC details in the docs?

For the most part I think we do have enough links. In particular I do
*not* want to see multiple references to the same variable in the same
paragraph all turned into links; that's just distracting.

regards, tom lane

#3Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#2)
Re: varname for GUC variables

Tom Lane wrote:

Bruce Momjian <bruce@momjian.us> writes:

I have applied the attached patch to use <varname> SGML markup
consistently for GUC variables. Should we be using <xref> to link to
more GUC details in the docs?

For the most part I think we do have enough links. In particular I do
*not* want to see multiple references to the same variable in the same
paragraph all turned into links; that's just distracting.

True on the multiple instances in a paragraph. I will drop it unless
someone feels we need more. Thanks.

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

+ It's impossible for everything to be true. +