Re: describe special values in GUC descriptions more consistently

From: Nathan Bossart <nathandbossart(at)gmail(dot)com>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: Peter Smith <smithpb2250(at)gmail(dot)com>, Daniel Gustafsson <daniel(at)yesql(dot)se>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: describe special values in GUC descriptions more consistently
Date: 2025-02-13 22:18:43
Message-ID: Z65vw3mBv8wa7Wfj@nathan
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Feb 12, 2025 at 04:10:53PM -0700, David G. Johnston wrote:
> 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.

Eh, most of the other descriptions with multiple sentences don't do that,
so IMHO there's no need for the special values to go in their own fragment.
You are correct that there should be no difference in the actual output.

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

I added a comment to guc_tables.h in v6.

--
nathan

Attachment Content-Type Size
v6-0001-Describe-special-values-in-GUC-descriptions-more-.patch text/plain 26.2 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Nathan Bossart 2025-02-13 22:32:10 Re: Remove a unnecessary argument from execute_extension_script()
Previous Message Álvaro Herrera 2025-02-13 21:38:36 Re: Simplify the logic a bit (src/bin/scripts/reindexdb.c)