Thread: GUC description cleanup

This patch makes the short_desc and extra_desc fields of the GUC table
more consistent: both text in both fields should be complete sentences
that begin with a capital letter and end in a period.

Note that this patch breaks the translations of these strings, so I
haven't applied it yet. Should I apply it now, or wait for 8.3 to
branch?

BTW, should pre_auth_delay be included in SHOW ALL? Its short_desc is
currently "No description available", so I think we should either add a
proper description or omit pre_auth_delay from SHOW ALL.

-Neil

Neil Conway <neilc@samurai.com> writes:
> BTW, should pre_auth_delay be included in SHOW ALL?

It's really just a debug aid, so I wouldn't complain if SHOW ALL didn't
show it.

            regards, tom lane

Neil Conway <neilc@samurai.com> writes:
> Note that this patch breaks the translations of these strings, so I
> haven't applied it yet. Should I apply it now, or wait for 8.3 to
> branch?

BTW, unless Peter says it's OK, my advice is to wait.  It's already
likely to be the case that translation updates are the critical path
for releasing 8.2.

            regards, tom lane

Am Donnerstag, 26. Oktober 2006 19:47 schrieb Neil Conway:
> Note that this patch breaks the translations of these strings, so I
> haven't applied it yet. Should I apply it now, or wait for 8.3 to
> branch?

I appreciate this effort, but I think it's better to hold the patch.

--
Peter Eisentraut
http://developer.postgresql.org/~petere/

On Fri, 2006-10-27 at 15:59 +0200, Peter Eisentraut wrote:
> I appreciate this effort, but I think it's better to hold the patch.

Sure, I'll wait for 8.3 to branch.

-Neil

Neil,

> Sure, I'll wait for 8.3 to branch.

I have some cleanup I want to do for 8.3 too.


Josh Berkus
PostgreSQL @ Sun
San Francisco 415-752-2500

On Fri, 2006-10-27 at 10:56 -0400, Neil Conway wrote:
> Sure, I'll wait for 8.3 to branch.

Attached is a revised version of this patch. I added a description for
pre_auth_delay (rather than removing it from SHOW ALL). I also removed
explicit mention of units from a bunch of description strings, since
after Peter's work for 8.2, some configuration variables can be
specified or displayed in several possible units. For example, the
current output from SHOW ALL is:

deadlock_timeout | 1s | The time in milliseconds to wait on lock before
checking for deadlock.

... which is plainly not a value "in milliseconds".

Barring any objections, I'll apply this to 8.3 (HEAD) tomorrow.

-Neil

Neil Conway <neilc@samurai.com> writes:
> Attached is a revised version of this patch.

The bgwriter parameter descriptions seem still, well, not good English.
For instance

> !             gettext_noop("Background writer maximum number of LRU pages to flush per round."),

ISTM this would read better as
    Maximum number of LRU pages to flush per activity round in the background writer.
or something else that betrays some understanding of English grammar ...

            regards, tom lane

On Sat, 2006-12-02 at 22:51 -0500, Tom Lane wrote:
> The bgwriter parameter descriptions seem still, well, not good English.

Indeed, there is still plenty of room for improvement, but exam period
prevents me from attempting anything more extensive at the moment...

Patch applied to HEAD.

-Neil