public inbox for pgsql-docs@postgresql.org  

help / color / mirror / Atom feed

From: Robert Treat <rob@xzilla.net>
To: Fujii Masao <masao.fujii@gmail.com>
Cc: Daniel Gustafsson <daniel@yesql.se>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: Index / glossary adjustments for Git & GUC
Date: Fri, 15 Aug 2025 00:12:57 -0400
Message-ID: <CAJSLCQ3ZpgA6d3RNbzz6h4Gv=xR70ZTgF65ayS7eDZrd_UhN2A@mail.gmail.com> (raw)
In-Reply-To: <CAHGQGwETTsf8ZFKWO3aVu-b6bQuNLS5PT2qx7NaxYMz-U2b1nA@mail.gmail.com>
References: <CABV9wwPQnkeo_G6-orMGnHPK9SXGVWm7ajJPzsbE6944tDx=hQ@mail.gmail.com>
	<FFBAE5D1-F0E6-4983-80B3-82FF0B1CF6F5@yesql.se>
	<CAHGQGwETTsf8ZFKWO3aVu-b6bQuNLS5PT2qx7NaxYMz-U2b1nA@mail.gmail.com>

On Wed, Aug 13, 2025 at 10:48 PM Fujii Masao <masao.fujii@gmail.com> wrote:
> On Wed, Aug 13, 2025 at 5:04 PM Daniel Gustafsson <daniel@yesql.se> wrote:
> > > On 13 Aug 2025, at 01:16, Robert Treat <rob@xzilla.net> wrote:
> >
> > > The first patch removes the term "Git" from the acronyms section and
> > > instead creates an index entry that points to our source repository
> > > information.
> >
> > This was previously discussed in this thread:
> >
> > https://postgr.es/m/8241CED6-F408-4660-A1AA-F3393AA26219%40yesql.se
> >
> > > For the second, ISTM we use the term GUC to refer to parameters pretty
> > > liberally, but the term is not that easy to find in the docs (and
> > > website search gives what is probably the best answer as result #7 of
> > > 8). This creates an index entry for the term, as well as a glossary
> > > entry which explains how it is commonly used.
> >
> > This seems like a good idea.
>
> +1
>
> +  <glossentry id="glossary-guc">
> +   <glossterm>GUC</glossterm>
>
> Should we also include the full term "Grand Unified Configuration" here, e.g.,
> "Grand unified configuration (GUC)", similar to how "Log sequence number (LSN)"
> is shown in the glossary? Even though it's already in the acronyms docs,
> it might be helpful to include it in the glossary as well.
>

So when I first wrote this, I wrote the following:

Originally a short-hand for Grand Unified Configuration, the subsystem
which controls PostgreSQL server configuration, it is now a commonly
used term for the individual configuration parameters themselves.
While typically meant to refer to user settable parameters, it can
also refer to internal or build-time parameters.

That felt a little verbose, and ISTM the more important part was
focusing on GUCs as postgres jargon for parameters rather than
explaining the history (which as you noted is explained elsewhere),
but I can see the argument for completeness over clarity.


Robert Treat
https://xzilla.net

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: rob@xzilla.net, masao.fujii@gmail.com, daniel@yesql.se, pgsql-docs@lists.postgresql.org
  Subject: Re: Index / glossary adjustments for Git & GUC
  In-Reply-To: <CAJSLCQ3ZpgA6d3RNbzz6h4Gv=xR70ZTgF65ayS7eDZrd_UhN2A@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox