From: Robert Haas <robertmhaas@gmail.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Bruce Momjian <bruce@momjian.us>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: [COMMITTERS] pgsql: remove tags.
Date: Mon, 7 Feb 2011 10:59:47 -0500
Message-ID: <AANLkTinvGSO2RXpmKvjQoA-6Ux7AxQB-T24GrsUBorcs@mail.gmail.com> (raw)
In-Reply-To: <15595.1297091285@sss.pgh.pa.us>
References: <AANLkTi=ytYtfkYYcb+_=JR=sByAwXNHD-J4-+T_EefaC@mail.gmail.com>
<201102071454.p17EskV22239@momjian.us>
<AANLkTim7FZvuqRB7r7yxcxFKgD0F241ue6o6BcxRUoX-@mail.gmail.com>
<15595.1297091285@sss.pgh.pa.us>
On Mon, Feb 7, 2011 at 10:08 AM, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> Robert Haas <robertmhaas@gmail.com> writes:
>> Which way did we more commonly do it before you applied this patch?
>
> We don't have a standard for this, and an undocumented patch applied
> without any discussion doesn't create one. It's hopeless to imagine
> that you'll ever achieve any uniformity that way. It won't last long
> if you do, since you're outnumbered by committers who won't be following
> whatever you think the convention is.
>
> I'm not even sure why you're trying --- I don't think it even makes
> sense to try to have a standard about this. I can easily imagine that
> integer constants might read better with <literal> in some contexts
> and better without in others.
*reads patch more carefully*
Here are my verdicts:
advanced.sgml: good
array.sgml: good
backup.sgml: unsure
catalogs.sgml: bad
client-auth.sgml: bad
config.sgml: bad
func.sgml: bad
high-availability.sgml: bad
libpq.sgml: bad
runtime.sgml: bad
spi.sgml: unsure
tsearch2.sgml: good
So I guess I'm back agreeing with you. Basically, it seems like we
ought to use <literal> if it's being used as a value that the user
might want to supply (e.g. "if you set this parameter to 0, then no
statements will be logged). It shouldn't use <literal> if it's just
being used as a number (e.g. "this query will return all airplanes
with a height of less than 30,000 feet"). The cases I'm unsure about
are the ones where we're talking about a return value (e.g. in the
event of an error, this function will return -1).
--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company
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 using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: robertmhaas@gmail.com, tgl@sss.pgh.pa.us, bruce@momjian.us
Subject: Re: [COMMITTERS] pgsql: remove tags.
In-Reply-To: <AANLkTinvGSO2RXpmKvjQoA-6Ux7AxQB-T24GrsUBorcs@mail.gmail.com>
* 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