public inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFrom: 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: Wed, 31 Dec 2025 10:39:20 -0500
Message-ID: <CAJSLCQ2iU3uEkPa1Ste4u-Lm574Z20+xy4TnDnXvrLrKkG44fg@mail.gmail.com> (raw)
In-Reply-To: <CAJSLCQ3ZpgA6d3RNbzz6h4Gv=xR70ZTgF65ayS7eDZrd_UhN2A@mail.gmail.com>
References: <CABV9wwPQnkeo_G6-orMGnHPK9SXGVWm7ajJPzsbE6944tDx=hQ@mail.gmail.com>
<FFBAE5D1-F0E6-4983-80B3-82FF0B1CF6F5@yesql.se>
<CAHGQGwETTsf8ZFKWO3aVu-b6bQuNLS5PT2qx7NaxYMz-U2b1nA@mail.gmail.com>
<CAJSLCQ3ZpgA6d3RNbzz6h4Gv=xR70ZTgF65ayS7eDZrd_UhN2A@mail.gmail.com>
On Fri, Aug 15, 2025 at 12:12 AM Robert Treat <rob@xzilla.net> wrote:
> 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.
> >
>
Howdy folks,
While doing some end of year clean up, I noticed I hadn't followed up
on this thread, so attached is an updated set of patches, the first of
which adds the index entry for git, and the second which adds the
glossary entry for GUC, both in accordance with the above feedback.
Robert Treat
https://xzilla.net
Attachments:
[application/octet-stream] v2-0001-Add-Git-to-the-index-pointing-towards-repo-info.patch (869B, 2-v2-0001-Add-Git-to-the-index-pointing-towards-repo-info.patch)
download | inline diff:
From c635f54f30fe71c98c243cb895051f04ea04210e Mon Sep 17 00:00:00 2001
From: Robert Treat <rob@xzilla.net>
Date: Tue, 12 Aug 2025 18:11:40 -0400
Subject: [PATCH v2 1/2] Add Git to the index, pointing towards repo info.
Content-Type: text/plain; charset="utf-8"
---
doc/src/sgml/sourcerepo.sgml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/doc/src/sgml/sourcerepo.sgml b/doc/src/sgml/sourcerepo.sgml
index f4368e83ab3..b9ea59ae329 100644
--- a/doc/src/sgml/sourcerepo.sgml
+++ b/doc/src/sgml/sourcerepo.sgml
@@ -3,6 +3,8 @@
<appendix id="sourcerepo">
<title>The Source Code Repository</title>
+ <indexterm zone="sourcerepo"><primary>Git</primary></indexterm>
+
<para>
The <productname>PostgreSQL</productname> source code is stored and managed
using the <productname>Git</productname> version control system. A public
--
2.24.3 (Apple Git-128)
[application/octet-stream] v2-0002-GUC-is-a-pretty-common-term-which-currently-only-.patch (1.8K, 3-v2-0002-GUC-is-a-pretty-common-term-which-currently-only-.patch)
download | inline diff:
From 4349ceb7f94a166d4274b054f580be92bc26808c Mon Sep 17 00:00:00 2001
From: Robert Treat <rob@xzilla.net>
Date: Tue, 12 Aug 2025 19:05:02 -0400
Subject: [PATCH v2 2/2] GUC is a pretty common term, which currently only
shows up in acronym, and #7 search term on website, so add index and glossary
entries.
Content-Type: text/plain; charset="utf-8"
---
doc/src/sgml/config.sgml | 2 ++
doc/src/sgml/glossary.sgml | 17 +++++++++++++++++
2 files changed, 19 insertions(+)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index cdfe8e376f0..755a6e19af7 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -18,6 +18,8 @@
<sect1 id="config-setting">
<title>Setting Parameters</title>
+ <indexterm><primary>GUC</primary></indexterm>
+
<sect2 id="config-setting-names-values">
<title>Parameter Names and Values</title>
diff --git a/doc/src/sgml/glossary.sgml b/doc/src/sgml/glossary.sgml
index a76cf5c383f..e2db5bcc78c 100644
--- a/doc/src/sgml/glossary.sgml
+++ b/doc/src/sgml/glossary.sgml
@@ -912,6 +912,23 @@
</glossdef>
</glossentry>
+ <glossentry id="glossary-guc">
+ <glossterm>GUC</glossterm>
+ <glossdef>
+ <para>
+ Based on a short-hand for Grand Unified Configuration, the subsystem
+ which controls server configuration, it is now a commonly used term
+ for the individual configuration parameters themselves. Typically meant
+ to refer to user settable parameters, it can also refer to internal or
+ build-time parameters.
+ </para>
+ <para>
+ For information on working with configuration parameters, see
+ <xref linkend="config-setting"/>.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id="glossary-heap">
<glossterm>Heap</glossterm>
<glossdef>
--
2.24.3 (Apple Git-128)
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: <CAJSLCQ2iU3uEkPa1Ste4u-Lm574Z20+xy4TnDnXvrLrKkG44fg@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