Stale comment in guc.h; publish listing of setting sources?

Started by David G. Johnston4 months ago4 messages
#1David G. Johnston
david.g.johnston@gmail.com

Hi,

* NB: see GucSource_Names in guc.c if you change this.

The constant was moved to guc_tables.c

Also, these seem like they should be documented for pg_settings.source

Per recent complaint:

/messages/by-id/04f101dc2288$121b2de0$365189a0$@msym.fr

David J.

#2Michael Paquier
michael@paquier.xyz
In reply to: David G. Johnston (#1)
Re: Stale comment in guc.h; publish listing of setting sources?

On Wed, Sep 10, 2025 at 01:02:46PM -0700, David G. Johnston wrote:

* NB: see GucSource_Names in guc.c if you change this.

The constant was moved to guc_tables.c

I would just remove the file reference. Knowing that GucSource_Names
matters is enough to grep for it. Documenting its location does not
matter.

Also, these seem like they should be documented for pg_settings.source

Per recent complaint:
/messages/by-id/04f101dc2288$121b2de0$365189a0$@msym.fr

Yeah, why not. Listing all of them GucSource_Names directly in the
docs may help if that clarifies things regarding some of the values.
The last additions in the list were 9475db3a4eb5 and f480e2944985, if
my grepping gets it right, pointing that this has a low risk of
rotting when a new one is added to the code, and forgotten in the
docs.
--
Michael

#3Michael Paquier
michael@paquier.xyz
In reply to: Michael Paquier (#2)
Re: Stale comment in guc.h; publish listing of setting sources?

On Thu, Sep 11, 2025 at 08:48:47AM +0900, Michael Paquier wrote:

I would just remove the file reference. Knowing that GucSource_Names
matters is enough to grep for it. Documenting its location does not
matter.

Actually, it matters, as GucSource_Names and GucSource need to be kept
in sync. I've fixed the comment for now down to v16.
--
Michael

#4David G. Johnston
david.g.johnston@gmail.com
In reply to: Michael Paquier (#3)
Re: Stale comment in guc.h; publish listing of setting sources?

On Wed, Sep 10, 2025 at 6:17 PM Michael Paquier <michael@paquier.xyz> wrote:

On Thu, Sep 11, 2025 at 08:48:47AM +0900, Michael Paquier wrote:

I would just remove the file reference. Knowing that GucSource_Names
matters is enough to grep for it. Documenting its location does not
matter.

Actually, it matters, as GucSource_Names and GucSource need to be kept
in sync. I've fixed the comment for now down to v16.

Thank you.

David J.