doc: Add glossary and index entries for GUC.

GUC is a commonly used term but previously appeared only
in the acronym documentation. This commit adds glossary and
documentation index entries for GUC to make it easier to find
and understand.

Author: Robert Treat <rob@xzilla.net>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CABV9wwPQnkeo_G6-orMGnHPK9SXGVWm7ajJPzsbE6944tDx=hQ@mail.gmail.com

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 601aa3afb8ee0466e2f708e895961b951d9a4bf5..0fad34da6eb0bed82a98de207782eed8cad3c5fd 100644 (file)
--- 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 a76cf5c383fc8512aa5592d9ab532160ec1e4d58..e2db5bcc78c8bae79a42b1ad0802c4a08c5531ab 100644 (file)
--- 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>