pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
pgsql: remove tags.
11+ messages / 3 participants
[nested] [flat]

* pgsql: remove tags.
@ 2011-02-06 23:44  Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 11+ messages in thread

From: Bruce Momjian @ 2011-02-06 23:44 UTC (permalink / raw)
  To: pgsql-committers@postgresql.org

remove tags.

Branch
------
master

Details
-------
http://git.postgresql.org/gitweb?p=postgresql.git;a=commitdiff;h=ad762426333aac5bd8e1ceac753bebe4a64...

Modified Files
--------------
doc/src/sgml/advanced.sgml          |    2 +-
doc/src/sgml/array.sgml             |    2 +-
doc/src/sgml/backup.sgml            |    4 ++--
doc/src/sgml/catalogs.sgml          |    5 ++---
doc/src/sgml/client-auth.sgml       |    8 ++++----
doc/src/sgml/config.sgml            |    7 +++----
doc/src/sgml/func.sgml              |    4 ++--
doc/src/sgml/high-availability.sgml |    2 +-
doc/src/sgml/libpq.sgml             |    2 +-
doc/src/sgml/runtime.sgml           |    4 ++--
doc/src/sgml/spi.sgml               |    2 +-
doc/src/sgml/tsearch2.sgml          |    2 +-
12 files changed, 21 insertions(+), 23 deletions(-)



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: pgsql: remove tags.
@ 2011-02-06 23:48  Bruce Momjian <bruce@momjian.us>
  parent: Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 11+ messages in thread

From: Bruce Momjian @ 2011-02-06 23:48 UTC (permalink / raw)
  To: Bruce Momjian <bruce@momjian.us>; +Cc: pgsql-committers@postgresql.org

Bruce Momjian wrote:
> remove tags.

Sorry, vague commit message (I forgot squash).

Can I will use git ammend to improve this message?

---------------------------------------------------------------------------


> 
> Branch
> ------
> master
> 
> Details
> -------
> http://git.postgresql.org/gitweb?p=postgresql.git;a=commitdiff;h=ad762426333aac5bd8e1ceac753bebe4a64...
> 
> Modified Files
> --------------
> doc/src/sgml/advanced.sgml          |    2 +-
> doc/src/sgml/array.sgml             |    2 +-
> doc/src/sgml/backup.sgml            |    4 ++--
> doc/src/sgml/catalogs.sgml          |    5 ++---
> doc/src/sgml/client-auth.sgml       |    8 ++++----
> doc/src/sgml/config.sgml            |    7 +++----
> doc/src/sgml/func.sgml              |    4 ++--
> doc/src/sgml/high-availability.sgml |    2 +-
> doc/src/sgml/libpq.sgml             |    2 +-
> doc/src/sgml/runtime.sgml           |    4 ++--
> doc/src/sgml/spi.sgml               |    2 +-
> doc/src/sgml/tsearch2.sgml          |    2 +-
> 12 files changed, 21 insertions(+), 23 deletions(-)
> 
> 
> -- 
> Sent via pgsql-committers mailing list (pgsql-committers@postgresql.org)
> To make changes to your subscription:
> http://www.postgresql.org/mailpref/pgsql-committers

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

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



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: pgsql: remove tags.
@ 2011-02-07 04:12  Tom Lane <tgl@sss.pgh.pa.us>
  parent: Bruce Momjian <bruce@momjian.us>
  0 siblings, 1 reply; 11+ messages in thread

From: Tom Lane @ 2011-02-07 04:12 UTC (permalink / raw)
  To: pgsql-hackers@postgresql.org; +Cc: Bruce Momjian <bruce@momjian.us>; pgsql-committers@postgresql.org

Bruce Momjian <bruce@momjian.us> writes:
> Bruce Momjian wrote:
>> remove tags.

> Sorry, vague commit message (I forgot squash).

> Can I will use git ammend to improve this message?

How about git revert, instead?  It's not apparent to me that these
changes were improvements.

			regards, tom lane



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: pgsql: remove tags.
@ 2011-02-07 04:58  Robert Haas <robertmhaas@gmail.com>
  parent: Tom Lane <tgl@sss.pgh.pa.us>
  0 siblings, 1 reply; 11+ messages in thread

From: Robert Haas @ 2011-02-07 04:58 UTC (permalink / raw)
  To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: pgsql-hackers@postgresql.org, Bruce Momjian <bruce@momjian.us>; pgsql-committers@postgresql.org

On Sun, Feb 6, 2011 at 11:12 PM, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> Bruce Momjian <bruce@momjian.us> writes:
>> Bruce Momjian wrote:
>>> remove tags.
>
>> Sorry, vague commit message (I forgot squash).
>
>> Can I will use git ammend to improve this message?

Absolutely not.

> How about git revert, instead?  It's not apparent to me that these
> changes were improvements.

I'll buy that one.

-- 
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 14:54  Bruce Momjian <bruce@momjian.us>
  parent: Robert Haas <robertmhaas@gmail.com>
  0 siblings, 1 reply; 11+ messages in thread

From: Bruce Momjian @ 2011-02-07 14:54 UTC (permalink / raw)
  To: Robert Haas <robertmhaas@gmail.com>; +Cc: Tom Lane <tgl@sss.pgh.pa.us>; pgsql-docs

Robert Haas wrote:
> On Sun, Feb 6, 2011 at 11:12 PM, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> > Bruce Momjian <bruce@momjian.us> writes:
> >> Bruce Momjian wrote:
> >>> remove tags.
> >
> >> Sorry, vague commit message (I forgot squash).
> >
> >> Can I will use git ammend to improve this message?
> 
> Absolutely not.
> 
> > How about git revert, instead? ?It's not apparent to me that these
> > changes were improvements.
> 
> I'll buy that one.

[  CC to docs, committers removed. ]

Well, if we want to revert, then we have to add <literal> to all the
numbers used in our docs --- there was no logic in what we previously
had.  Do we want that?

Here is an example line I did not change:

   an otherwise idle connection.  A value of 0 uses the system default.

Do we want that 0 to appear in a fixed-width font via <literal>?
It is easy to do but we should decide.

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

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



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 14:58  Robert Haas <robertmhaas@gmail.com>
  parent: Bruce Momjian <bruce@momjian.us>
  0 siblings, 2 replies; 11+ messages in thread

From: Robert Haas @ 2011-02-07 14:58 UTC (permalink / raw)
  To: Bruce Momjian <bruce@momjian.us>; +Cc: Tom Lane <tgl@sss.pgh.pa.us>; pgsql-docs

On Mon, Feb 7, 2011 at 9:54 AM, Bruce Momjian <bruce@momjian.us> wrote:
> Robert Haas wrote:
>> On Sun, Feb 6, 2011 at 11:12 PM, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>> > Bruce Momjian <bruce@momjian.us> writes:
>> >> Bruce Momjian wrote:
>> >>> remove tags.
>> >
>> >> Sorry, vague commit message (I forgot squash).
>> >
>> >> Can I will use git ammend to improve this message?
>>
>> Absolutely not.
>>
>> > How about git revert, instead? ?It's not apparent to me that these
>> > changes were improvements.
>>
>> I'll buy that one.
>
> [  CC to docs, committers removed. ]
>
> Well, if we want to revert, then we have to add <literal> to all the
> numbers used in our docs --- there was no logic in what we previously
> had.  Do we want that?
>
> Here is an example line I did not change:
>
>   an otherwise idle connection.  A value of 0 uses the system default.
>
> Do we want that 0 to appear in a fixed-width font via <literal>?
> It is easy to do but we should decide.

[ removing -hackers from CC also, no need to cross-post ]

Hmm.  I'm starting to lean toward leaving this as you have it.

Which way did we more commonly do it before you applied this patch?

-- 
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 15:08  Tom Lane <tgl@sss.pgh.pa.us>
  parent: Robert Haas <robertmhaas@gmail.com>
  1 sibling, 2 replies; 11+ messages in thread

From: Tom Lane @ 2011-02-07 15:08 UTC (permalink / raw)
  To: Robert Haas <robertmhaas@gmail.com>; +Cc: Bruce Momjian <bruce@momjian.us>; pgsql-docs

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.

			regards, tom lane



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 15:54  Bruce Momjian <bruce@momjian.us>
  parent: Robert Haas <robertmhaas@gmail.com>
  1 sibling, 0 replies; 11+ messages in thread

From: Bruce Momjian @ 2011-02-07 15:54 UTC (permalink / raw)
  To: Robert Haas <robertmhaas@gmail.com>; +Cc: Tom Lane <tgl@sss.pgh.pa.us>; pgsql-docs

Robert Haas wrote:
> On Mon, Feb 7, 2011 at 9:54 AM, Bruce Momjian <bruce@momjian.us> wrote:
> > Robert Haas wrote:
> >> On Sun, Feb 6, 2011 at 11:12 PM, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> >> > Bruce Momjian <bruce@momjian.us> writes:
> >> >> Bruce Momjian wrote:
> >> >>> remove tags.
> >> >
> >> >> Sorry, vague commit message (I forgot squash).
> >> >
> >> >> Can I will use git ammend to improve this message?
> >>
> >> Absolutely not.
> >>
> >> > How about git revert, instead? ?It's not apparent to me that these
> >> > changes were improvements.
> >>
> >> I'll buy that one.
> >
> > [ ?CC to docs, committers removed. ]
> >
> > Well, if we want to revert, then we have to add <literal> to all the
> > numbers used in our docs --- there was no logic in what we previously
> > had. ?Do we want that?
> >
> > Here is an example line I did not change:
> >
> > ? an otherwise idle connection. ?A value of 0 uses the system default.
> >
> > Do we want that 0 to appear in a fixed-width font via <literal>?
> > It is easy to do but we should decide.
> 
> [ removing -hackers from CC also, no need to cross-post ]
> 
> Hmm.  I'm starting to lean toward leaving this as you have it.
> 
> Which way did we more commonly do it before you applied this patch?

It was mostly like the line I have above, meaning it was not in
fixed-width font, 95% I would say.  I modified 19 to be like the rest. 
I left <literal> where the context made sense.

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

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



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 15:59  Robert Haas <robertmhaas@gmail.com>
  parent: Tom Lane <tgl@sss.pgh.pa.us>
  1 sibling, 1 reply; 11+ messages in thread

From: Robert Haas @ 2011-02-07 15:59 UTC (permalink / raw)
  To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Bruce Momjian <bruce@momjian.us>; pgsql-docs

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



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 15:59  Bruce Momjian <bruce@momjian.us>
  parent: Tom Lane <tgl@sss.pgh.pa.us>
  1 sibling, 0 replies; 11+ messages in thread

From: Bruce Momjian @ 2011-02-07 15:59 UTC (permalink / raw)
  To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Robert Haas <robertmhaas@gmail.com>; pgsql-docs

Tom Lane 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.

Well, the problem is that we then have paragraphs where a number is
fixed width, and in the next paragraph it isn't;  this is particuarly
true in the config.sgml file where we show defaults.  Seems worth trying
to make that consistent.  I am happy to do whatever we agree on --- I
don't have an opinion.

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

Yes, I reviewed all the places and left <literal> where it made sense.

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

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



^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: [COMMITTERS] pgsql: remove tags.
@ 2011-02-07 16:01  Bruce Momjian <bruce@momjian.us>
  parent: Robert Haas <robertmhaas@gmail.com>
  0 siblings, 0 replies; 11+ messages in thread

From: Bruce Momjian @ 2011-02-07 16:01 UTC (permalink / raw)
  To: Robert Haas <robertmhaas@gmail.com>; +Cc: Tom Lane <tgl@sss.pgh.pa.us>; pgsql-docs

Robert Haas wrote:
> 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).

OK, let's decide what we want and I will make it happen.

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

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



^ permalink  raw  reply  [nested|flat] 11+ messages in thread


end of thread, other threads:[~2011-02-07 16:01 UTC | newest]

Thread overview: 11+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2011-02-06 23:44 pgsql: remove tags. Bruce Momjian <bruce@momjian.us>
2011-02-06 23:48 ` Bruce Momjian <bruce@momjian.us>
2011-02-07 04:12   ` Tom Lane <tgl@sss.pgh.pa.us>
2011-02-07 04:58     ` Robert Haas <robertmhaas@gmail.com>
2011-02-07 14:54       ` Bruce Momjian <bruce@momjian.us>
2011-02-07 14:58         ` Robert Haas <robertmhaas@gmail.com>
2011-02-07 15:08           ` Tom Lane <tgl@sss.pgh.pa.us>
2011-02-07 15:59             ` Robert Haas <robertmhaas@gmail.com>
2011-02-07 16:01               ` Bruce Momjian <bruce@momjian.us>
2011-02-07 15:59             ` Bruce Momjian <bruce@momjian.us>
2011-02-07 15:54           ` Bruce Momjian <bruce@momjian.us>

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