0001-doc-Fix-glossary-entry-for-data-checksums-workers.patch

application/octet-stream

Filename: 0001-doc-Fix-glossary-entry-for-data-checksums-workers.patch
Type: application/octet-stream
Part: 0
Message: Re: Fix data checksum progress reporting docs

Patch

Format: format-patch
Series: patch 0001
Subject: doc: Fix glossary entry for data checksums workers
File+
doc/src/sgml/glossary.sgml 12 20
From 740c9c8e44dc7c419a2ceb0207c43f7588229e87 Mon Sep 17 00:00:00 2001
From: Daniel Gustafsson <dgustafsson@postgresql.org>
Date: Thu, 9 Jul 2026 10:23:22 +0200
Subject: [PATCH] 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 implementerd as background
workers.  Fix, and while there, simplify the entry by combining the
worker and launcher into a single glossary term.

Reported-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAHGQGwEv-C9ia+rBYyePzO8F=5FVvS412ZqcOupazuOb5RafNg@mail.gmail.com
---
 doc/src/sgml/glossary.sgml | 32 ++++++++++++--------------------
 1 file changed, 12 insertions(+), 20 deletions(-)

diff --git a/doc/src/sgml/glossary.sgml b/doc/src/sgml/glossary.sgml
index f7f69afc922..4f841fb5886 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 worker launcher</firstterm> and the process
+     which operate on the individual databases is known as the
+     <firstterm>data checksums worker</firstterm>.
     </para>
    </glossdef>
   </glossentry>
-- 
2.39.3 (Apple Git-146)