minor documentation improvements

Neil Conway writes:

This patch makes a few minor improvements to the docs: make the
<varname> conventions more consistent,

They are consistent: They're all lowercase. Until now.

--
Peter Eisentraut peter_e@gmx.net

Peter Eisentraut wrote:

Neil Conway writes:

This patch makes a few minor improvements to the docs: make the
<varname> conventions more consistent,

They are consistent: They're all lowercase. Until now.

Huh? We have been uppercasing GUC variable names in most places
already.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

Bruce Momjian writes:

Huh? We have been uppercasing GUC variable names in most places
already.

Currently, the documentation contains about 2 GUC variable names in upper
case, the rest is lower case. (The exception are the list headings in the
main description in runtime.sgml, which are all upper case. That is a bit
inconsistent, but I think it's OK, because here they sort of serve as
section titles.) Also note that postgresql.conf, command-line option
equivalents, and SET commands all tend to use them in lower case, so that
seems like the direction to go.

--
Peter Eisentraut peter_e@gmx.net

Peter Eisentraut wrote:

Bruce Momjian writes:

Huh? We have been uppercasing GUC variable names in most places
already.

Currently, the documentation contains about 2 GUC variable names in upper
case, the rest is lower case. (The exception are the list headings in the
main description in runtime.sgml, which are all upper case. That is a bit
inconsistent, but I think it's OK, because here they sort of serve as
section titles.) Also note that postgresql.conf, command-line option
equivalents, and SET commands all tend to use them in lower case, so that
seems like the direction to go.

Oh, OK, got it.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

On Fri, 2003-09-05 at 17:16, Peter Eisentraut wrote:

Currently, the documentation contains about 2 GUC variable names in upper
case, the rest is lower case.

There are significantly more than 2 uses of upper-case GUC names in the
docs (more like 10 by my guess), but in any case, the current usage is
inconsistent.

So, is upper-case or lower-case better? I'd personally prefer
lower-case, I suppose, but I'm not too bothered either way.

-Neil

Peter Eisentraut <peter_e@gmx.net> writes:

Neil Conway writes:

This patch makes a few minor improvements to the docs: make the
<varname> conventions more consistent,

They are consistent: They're all lowercase. Until now.

The varnames listed in runtime.sgml are uppercase though, no? Or were
you intending the variable definitions to be upper case and all the
references lower case? It's not real clear what the intended style is,
and I have to say that I thought Neil was heading in the intended
direction also.

regards, tom lane

Peter Eisentraut <peter_e@gmx.net> writes:

Bruce Momjian writes:

Huh? We have been uppercasing GUC variable names in most places
already.

Currently, the documentation contains about 2 GUC variable names in upper
case, the rest is lower case. (The exception are the list headings in the
main description in runtime.sgml, which are all upper case. That is a bit
inconsistent, but I think it's OK, because here they sort of serve as
section titles.)

Okay, that seems reasonable. Ignore my prior message --- I hadn't come
across this one yet.

regards, tom lane

Neil Conway writes:

So, is upper-case or lower-case better? I'd personally prefer
lower-case, I suppose, but I'm not too bothered either way.

If you want to change them all to lowercase, that would be fine by me. At
least it would prevent more people being confused into inconsistencies in
the future.

--
Peter Eisentraut peter_e@gmx.net

Peter Eisentraut wrote:

Neil Conway writes:

So, is upper-case or lower-case better? I'd personally prefer
lower-case, I suppose, but I'm not too bothered either way.

If you want to change them all to lowercase, that would be fine by me. At
least it would prevent more people being confused into inconsistencies in
the future.

Have we come to a conclusion here --- that we should lowercase _all_ GUC
variable references, both in runtime.sgml, SGML docs, and error
messages?

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

Patch applied. I will now go through and lowercase all the GUC
variable names, as agreed upon.

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

Neil Conway wrote:

This patch makes a few minor improvements to the docs: make the
<varname> conventions more consistent, and improve the ANALYZE ref page.

-Neil

[ Attachment, skipping... ]

---------------------------(end of broadcast)---------------------------
TIP 3: if posting/reading through Usenet, please send an appropriate
subscribe-nomail command to majordomo@postgresql.org so that your
message can get through to the mailing list cleanly

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

Patch attached and applied.

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

Bruce Momjian wrote:

Patch applied. I will now go through and lowercase all the GUC
variable names, as agreed upon.

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

Neil Conway wrote:

This patch makes a few minor improvements to the docs: make the
<varname> conventions more consistent, and improve the ANALYZE ref page.

-Neil

[ Attachment, skipping... ]

---------------------------(end of broadcast)---------------------------
TIP 3: if posting/reading through Usenet, please send an appropriate
subscribe-nomail command to majordomo@postgresql.org so that your
message can get through to the mailing list cleanly

-- 
Bruce Momjian                        |  http://candle.pha.pa.us
pgman@candle.pha.pa.us               |  (610) 359-1001
+  If your life is a hard drive,     |  13 Roberts Road
+  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

---------------------------(end of broadcast)---------------------------
TIP 8: explain analyze is your friend

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073