From: Daniel Gustafsson <dgustafsson@postgresql.org>
Date: Sat, 1 Aug 2026 19:35:19 +0000 (+0200)
Subject: doc: Fix glossary entry for data checksums workers
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c5ad377da7437f44628e3c4cc2e6fceb98cdcec5;p=thirdparty%2Fpostgresql.git

doc: Fix glossary entry for data checksums workers

The glossary entry for data checksums workers incorrectly stated that
they were auxiliary processes, but they are implemented as background
workers.  Fix, and while there, simplify the entry by combining the
worker and launcher into a single glossary term.  Backpatch down to
v19 where online checksums were introduced.

Author: Daniel Gustafsson <daniel@yesql.se>
Reported-by: Fujii Masao <masao.fujii@gmail.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAHGQGwEv-C9ia+rBYyePzO8F=5FVvS412ZqcOupazuOb5RafNg@mail.gmail.com
Backpatch-through: 19
---

diff --git a/doc/src/sgml/glossary.sgml b/doc/src/sgml/glossary.sgml
index f7f69afc922..b86de809a89 100644
--- a/doc/src/sgml/glossary.sgml
+++ b/doc/src/sgml/glossary.sgml
@@ -199,8 +199,6 @@
      (but not the autovacuum workers),
      the <glossterm linkend="glossary-background-writer">background writer</glossterm>,
      the <glossterm linkend="glossary-checkpointer">checkpointer</glossterm>,
-     the <glossterm linkend="glossary-data-checksums-worker">data checksums worker</glossterm>,
-     the <glossterm linkend="glossary-data-checksums-worker-launcher">data checksums worker launcher</glossterm>,
      the <glossterm linkend="glossary-logger">logger</glossterm>,
      the <glossterm linkend="glossary-startup-process">startup process</glossterm>,
      the <glossterm linkend="glossary-wal-archiver">WAL archiver</glossterm>,
@@ -236,8 +234,9 @@
      which runs system- or user-supplied code.
      Serves as infrastructure for several features in
      <productname>PostgreSQL</productname>, such as
-     <glossterm linkend="glossary-replication">logical replication</glossterm>
-     and <glossterm linkend="glossary-parallel-query">parallel queries</glossterm>.
+     <glossterm linkend="glossary-replication">logical replication</glossterm>,
+     <glossterm linkend="glossary-parallel-query">parallel queries</glossterm> and
+     <glossterm linkend="glossary-data-checksums-process">data checksums processing</glossterm>.
      In addition, <glossterm linkend="glossary-extension">Extensions</glossterm> can add
      custom background worker processes.
    </para>
@@ -588,24 +587,17 @@
    <glosssee otherterm="glossary-data-directory" />
   </glossentry>
 
-  <glossentry id="glossary-data-checksums-worker">
-   <glossterm>Data Checksums Worker</glossterm>
+  <glossentry id="glossary-data-checksums-process">
+   <glossterm>Data Checksums (process)</glossterm>
    <glossdef>
     <para>
-     A <glossterm linkend="glossary-background-worker">background worker</glossterm>
-     which enables data checksums in a specific database.
-    </para>
-   </glossdef>
-  </glossentry>
-
-  <glossentry id="glossary-data-checksums-worker-launcher">
-   <glossterm>Data Checksums Worker Launcher</glossterm>
-   <glossdef>
-    <para>
-     A <glossterm linkend="glossary-background-worker">background worker</glossterm>
-     which starts <glossterm linkend="glossary-data-checksums-worker"> data
-     checksum worker</glossterm> processes for enabling data checksums in each
-     database, or disables data checksums cluster-wide.
+     A set of
+     <glossterm linkend="glossary-background-worker">background worker</glossterm>
+     processes which can enable or disable data checksums in a running cluster.
+     The process which coordinates the work is known as the
+     <firstterm>data checksums launcher</firstterm> and the process which
+     operates on the individual databases is known as the
+     <firstterm>data checksums worker</firstterm>.
     </para>
    </glossdef>
   </glossentry>