Received: from malur.postgresql.org ([217.196.149.56])
	by arkaria.postgresql.org with esmtps  (TLS1.3) tls
 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
	(Exim 4.94.2)
	(envelope-from <pgsql-hackers-owner+archive@lists.postgresql.org>)
	id 1sGxSP-001PJb-LM
	for pgsql-hackers@arkaria.postgresql.org; Tue, 11 Jun 2024 09:06:22 +0000
Received: from localhost ([127.0.0.1] helo=malur.postgresql.org)
	by malur.postgresql.org with esmtp (Exim 4.94.2)
	(envelope-from <pgsql-hackers-owner+archive@lists.postgresql.org>)
	id 1sGxSN-004Kkt-Bo
	for pgsql-hackers@arkaria.postgresql.org; Tue, 11 Jun 2024 09:06:20 +0000
Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29])
	by malur.postgresql.org with esmtps  (TLS1.3) tls
 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
	(Exim 4.94.2)
	(envelope-from <ikedamsh@oss.nttdata.com>)
	id 1sGxSN-004Kkl-1u
	for pgsql-hackers@lists.postgresql.org; Tue, 11 Jun 2024 09:06:19 +0000
Received: from oss.nttdata.com ([49.212.34.109])
	by magus.postgresql.org with esmtps  (TLS1.2) tls
 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
	(Exim 4.94.2)
	(envelope-from <ikedamsh@oss.nttdata.com>)
	id 1sGxSL-0014wS-0L
	for pgsql-hackers@lists.postgresql.org; Tue, 11 Jun 2024 09:06:19 +0000
Received: from oss.nttdata.com (localhost [127.0.0.1])
	by oss.nttdata.com (Postfix) with ESMTPA id 6283C609D4
	for <pgsql-hackers@lists.postgresql.org>;
 Tue, 11 Jun 2024 18:06:11 +0900 (JST)
X-Virus-Status: Clean
X-Virus-Scanned: clamav-milter 0.103.11 at oss.nttdata.com
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII;
 format=flowed
Content-Transfer-Encoding: 7bit
Date: Tue, 11 Jun 2024 18:06:11 +0900
From: Masahiro Ikeda <ikedamsh@oss.nttdata.com>
To: pgsql-hackers@lists.postgresql.org
Subject: Doc: fix a description regarding WAL summarizer on glossary page
User-Agent: Roundcube Webmail/1.4.11
Message-ID: <d3a5a4278fd8d9e7a47c6aa4db9e9a39@oss.nttdata.com>
X-Sender: ikedamsh@oss.nttdata.com
List-Id: <pgsql-hackers.lists.postgresql.org>
List-Help: <https://lists.postgresql.org/manage/>
List-Subscribe: <https://lists.postgresql.org/manage/>
List-Post: <mailto:pgsql-hackers@lists.postgresql.org>
List-Owner: <mailto:pgsql-hackers-owner@lists.postgresql.org>
List-Archive: <https://www.postgresql.org/list/pgsql-hackers>
Archived-At: 
 <https://www.postgresql.org/message-id/d3a5a4278fd8d9e7a47c6aa4db9e9a39%40oss.nttdata.com>
Precedence: bulk

Hi,

While searching the definition of auxiliary processes, I noticed that 
the
description of the WAL summarizer is incorrect. Additionally, I think 
it's
better to add a description for the WAL writer similar to other 
Auxiliary
processes. What do you think?

# patch

```
diff --git a/doc/src/sgml/glossary.sgml b/doc/src/sgml/glossary.sgml
index a81c17a869..405fe6dc8b 100644
--- a/doc/src/sgml/glossary.sgml
+++ b/doc/src/sgml/glossary.sgml
@@ -164,6 +164,7 @@
       the <glossterm linkend="glossary-wal-archiver">WAL 
archiver</glossterm>,
       the <glossterm linkend="glossary-wal-receiver">WAL 
receiver</glossterm>
       (but not the <glossterm linkend="glossary-wal-sender">WAL 
senders</glossterm>),
+     the <glossterm linkend="glossary-wal-summarizer">WAL 
summarizer</glossterm>,
       and the <glossterm linkend="glossary-wal-writer">WAL 
writer</glossterm>.
      </para>
     </glossdef>
@@ -2199,7 +2200,7 @@
     <glossterm>WAL summarizer (process)</glossterm>
     <glossdef>
      <para>
-     A special <glossterm linkend="glossary-backend">backend 
process</glossterm>
+     An <glossterm linkend="glossary-auxiliary-proc">auxiliary 
process</glossterm>
       that summarizes WAL data for
       <glossterm linkend="glossary-incremental-backup">incremental 
backups</glossterm>.
      </para>
@@ -2213,7 +2214,8 @@
     <glossterm>WAL writer (process)</glossterm>
     <glossdef>
      <para>
-     A process that writes <glossterm linkend="glossary-wal-record">WAL 
records</glossterm>
+     An <glossterm linkend="glossary-auxiliary-proc">auxiliary 
process</glossterm>
+     that writes <glossterm linkend="glossary-wal-record">WAL 
records</glossterm>
       from <glossterm linkend="glossary-shared-memory">shared 
memory</glossterm> to
       <glossterm linkend="glossary-wal-file">WAL files</glossterm>.
      </para>
```

# additional information

As mentioned in miscadmin.h, WAL summarizer is one of auxiliary 
processes.
(postgres/src/include/miscadmin.h)
```
	/*
	 * Auxiliary processes. These have PGPROC entries, but they are not
	 * attached to any particular database. There can be only one of each 
of
	 * these running at a time.
	 *
	 * If you modify these, make sure to update NUM_AUXILIARY_PROCS and the
	 * glossary in the docs.
	 */
	B_ARCHIVER,
	B_BG_WRITER,
	B_CHECKPOINTER,
	B_STARTUP,
	B_WAL_RECEIVER,
	B_WAL_SUMMARIZER,
	B_WAL_WRITER,
```
Indeed, it calls InitAuxiliaryProcess() instead of InitProcess().

But, the description of WAL summarizer says that it's one of backend 
processes.
> WAL summarizer (process)
> A special backend process that summarizes WAL data for incremental 
> backups.
https://www.postgresql.org/docs/devel/glossary.html


Regards,
-- 
Masahiro Ikeda
NTT DATA CORPORATION