Re: doc: fast access to server parameters

On Wed, Aug 5, 2026, at 9:47 AM, Fujii Masao wrote:
>>
>> If you want to check a GUC description, you access the "Server Configuration"
>> chapter and then need to figure out what is the exact section. Sometimes you
>> need a back-and-forth until find the exact GUC. You can click on the section
>> 19.X and then browse to find the GUC. I was wondering if there is a better (and
>> fast) way to find a GUC.
>
> Isn't the existing index sufficient for jumping from a known GUC name to
> its documentation? If some GUCs are missing from the index or are hard to find,
> it seems better to improve the index entries than to add a second generated
> list of the same items.
>

That's a fair point. The problems with the Index are that (a) the
configuration parameters are mixed with other terms (ideally it should
be only GUCs), (b) the links are not direct to the exact
configuration parameter but the section it is contained (long number of
parameters mean you need to scroll down until you find the parameter)
and (c) it is hidden (unless you have browsed through the index, it is
not intuitive that all configuration parameters are listed there. A new
"Configuration Parameters" section would bring visibility to the
configuration parameters).

As I mention it is a specific reference to configuration parameters. The
goal is to have an easy UI to find a configuration parameter
description.

--
Euler Taveira
EDB https://www.enterprisedb.com/