public inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFrom: Robert Treat <rob@xzilla.net>
To: pgsql-docs@lists.postgresql.org
Subject: Index / glossary adjustments for Git & GUC
Date: Tue, 12 Aug 2025 19:16:40 -0400
Message-ID: <CABV9wwPQnkeo_G6-orMGnHPK9SXGVWm7ajJPzsbE6944tDx=hQ@mail.gmail.com> (raw)
Howdy folks,
Two small "clean up" patches. These are against HEAD, though could
likely be backpatched to v18 if one were inclined.
The first patch removes the term "Git" from the acronyms section and
instead creates an index entry that points to our source repository
information.
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.
Robert Treat
https://xzilla.net
Attachments:
[application/octet-stream] v1-0001-Remove-git-from-the-acronyms-section-since-it-is-.patch (1.5K, 2-v1-0001-Remove-git-from-the-acronyms-section-since-it-is-.patch)
download | inline diff:
From c184bf7e715e52f138b5e3809bd65a9294b23d8b Mon Sep 17 00:00:00 2001
From: Robert Treat <rob@xzilla.net>
Date: Tue, 12 Aug 2025 18:11:40 -0400
Subject: [PATCH v1 1/2] Remove git from the acronyms section, since it is not
one. Add entry in the index, pointing towards our repo info.
Content-Type: text/patch; charset="utf-8"
---
doc/src/sgml/acronyms.sgml | 10 ----------
doc/src/sgml/sourcerepo.sgml | 2 ++
2 files changed, 2 insertions(+), 10 deletions(-)
diff --git a/doc/src/sgml/acronyms.sgml b/doc/src/sgml/acronyms.sgml
index 2f906e9f018..511c7fd1a5d 100644
--- a/doc/src/sgml/acronyms.sgml
+++ b/doc/src/sgml/acronyms.sgml
@@ -273,16 +273,6 @@
</listitem>
</varlistentry>
- <varlistentry>
- <term><acronym>Git</acronym></term>
- <listitem>
- <para>
- <ulink
- url="https://en.wikipedia.org/wiki/Git">Git</ulink>
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term><acronym>GMT</acronym></term>
<listitem>
diff --git a/doc/src/sgml/sourcerepo.sgml b/doc/src/sgml/sourcerepo.sgml
index 6c13c5a30cd..3ecb4cd7f76 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] v1-0002-GUC-is-a-pretty-common-term-which-currently-only-.patch (1.7K, 3-v1-0002-GUC-is-a-pretty-common-term-which-currently-only-.patch)
download | inline diff:
From 48d09cd2c6fef78592b570a9458e41512dbb445e Mon Sep 17 00:00:00 2001
From: Robert Treat <rob@xzilla.net>
Date: Tue, 12 Aug 2025 19:05:02 -0400
Subject: [PATCH v1 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/patch; charset="utf-8"
---
doc/src/sgml/config.sgml | 2 ++
doc/src/sgml/glossary.sgml | 15 +++++++++++++++
2 files changed, 17 insertions(+)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 20ccb2d6b54..e12d1ff3087 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 b88cac598e9..086909c7305 100644
--- a/doc/src/sgml/glossary.sgml
+++ b/doc/src/sgml/glossary.sgml
@@ -897,6 +897,21 @@
</glossdef>
</glossentry>
+ <glossentry id="glossary-guc">
+ <glossterm>GUC</glossterm>
+ <glossdef>
+ <para>
+ Commonly used term within <productname>PostgreSQL</productname> for
+ configuration parameters. Typically meant to refer to user settable
+ parameters, but 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, pgsql-docs@lists.postgresql.org
Subject: Re: Index / glossary adjustments for Git & GUC
In-Reply-To: <CABV9wwPQnkeo_G6-orMGnHPK9SXGVWm7ajJPzsbE6944tDx=hQ@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