Re: describe special values in GUC descriptions more consistently

On Wed, Feb 12, 2025 at 3:47 PM Nathan Bossart <nathandbossart(at)gmail(dot)com>
wrote:

> Good catch. I've fixed that in v5.
>
>
I presume it doesn't affect the actual output which just concatenates the
fragments together but the source placement probably should be made
consistent; the line containing the initial default value specification
begins its own quoted fragment. The following violate that convention.

gettext_noop("Write a message to the server log if checkpoints "
"caused by the filling of WAL segment files happen more "
- "frequently than this amount of time. "
- "Zero turns off the warning."),
+ "frequently than this amount of time. 0 disables the "
+ "warning."),

//move beginning with 0 to the last line

gettext_noop("Number of consecutive keepalive retransmits that can be "
- "lost before a connection is considered dead. A value of 0 uses the "
- "system default."),
+ "lost before a connection is considered dead. 0 "
+ "means use the system default."),

//just move the 0 to the last line

gettext_noop("Replication slots will be marked as failed, and segments
released "
"for deletion or recycling, if this much space is occupied by WAL "
- "on disk."),
+ "on disk. -1 means no maximum."),

//move on disk to the prior line, unless there is some kind of length
limitation that should be documented as well.

gettext_noop("Write a message to the server log if checkpoints "
"caused by the filling of WAL segment files happen more "
- "frequently than this amount of time. "
- "Zero turns off the warning."),
+ "frequently than this amount of time. 0 disables the "
+ "warning."),

//move beginning with zero to the last line.

gettext_noop("The owning user of the socket is always the user "
- "that starts the server.")
+ "that starts the server. An empty string means use "
+ "the user's default group.")

//two lines probably...second begins 'An empty string'

Also, maybe put the rules in the commit message into a comment in the file,
or a README, instead.

David J.