Doc: fix a description regarding WAL summarizer on glossary page

pg.ddx.io  pgsql-hackers@postgresql.org mailing list archive  
help / color / mirror / Atom feed

Doc: fix a description regarding WAL summarizer on glossary page
5+ messages / 3 participants
[nested] [flat]

Commits from this thread:
  2024-06-14 d872e1b473  doc: Fix description WAL summarizer in glossary
  2024-06-14 3c992361cd d0b0454d38 37c5e5f4d4  doc: Fix description WAL writer in glossary

* Doc: fix a description regarding WAL summarizer on glossary page
@ 2024-06-11 09:06  Masahiro Ikeda <ikedamsh@oss.nttdata.com>
  0 siblings, 1 reply; 5+ messages in thread

From: Masahiro Ikeda @ 2024-06-11 09:06 UTC (permalink / raw)
  To: pgsql-hackers@lists.postgresql.org

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

```
inline patch 1: doc/src/sgml/glossary.sgml (+0/-0 lines) download inline-1.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





^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: Doc: fix a description regarding WAL summarizer on glossary page
@ 2024-06-11 22:52  Michael Paquier <michael@paquier.xyz>
  parent: Masahiro Ikeda <ikedamsh@oss.nttdata.com>
  0 siblings, 1 reply; 5+ messages in thread

From: Michael Paquier @ 2024-06-11 22:52 UTC (permalink / raw)
  To: Masahiro Ikeda <ikedamsh@oss.nttdata.com>; +Cc: pgsql-hackers@lists.postgresql.org

On Tue, Jun 11, 2024 at 06:06:11PM +0900, Masahiro Ikeda wrote:
> 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?

Good catch.  Would you like to attach a patch?
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* RE: Doc: fix a description regarding WAL summarizer on glossary page
@ 2024-06-13 07:24  Masahiro.Ikeda@nttdata.com
  parent: Michael Paquier <michael@paquier.xyz>
  0 siblings, 1 reply; 5+ messages in thread

From: Masahiro.Ikeda@nttdata.com @ 2024-06-13 07:24 UTC (permalink / raw)
  To: michael@paquier.xyz; ikedamsh@oss.nttdata.com; +Cc: pgsql-hackers@lists.postgresql.org; Masao.Fujii@nttdata.com

>> 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?
>
> Good catch.  Would you like to attach a patch?

Thanks for your response. Please take a look at the attached patch.
I've confirmed that it passes all tests.

Regards,
--
Masahiro Ikeda
NTT DATA CORPORATION
=

Attachments:

0001-doc-Fix-description-of-WAL-summarizer-and-WAL-writer.patch (application/octet-stream, 2.0K) download
From 0716ed5da68ab81aabaa943abba41b755da96733 Mon Sep 17 00:00:00 2001
From: Masahiro Ikeda <ikedamsh@oss.nttdata.com>
Date: Wed, 12 Jun 2024 09:56:05 +0900
Subject: [PATCH] doc: Fix description of WAL summarizer and WAL writer

Fix the description of the WAL summarizer on the glossary page,
as it was incorrect. Additionally, provide more detailed
specifications for WAL writer.
---
 doc/src/sgml/glossary.sgml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

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>
-- 
2.34.1



^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: Doc: fix a description regarding WAL summarizer on glossary page
@ 2024-06-13 08:01  Michael Paquier <michael@paquier.xyz>
  parent: Masahiro.Ikeda@nttdata.com
  0 siblings, 1 reply; 5+ messages in thread

From: Michael Paquier @ 2024-06-13 08:01 UTC (permalink / raw)
  To: Masahiro.Ikeda@nttdata.com; +Cc: ikedamsh@oss.nttdata.com; pgsql-hackers@lists.postgresql.org; Masao.Fujii@nttdata.com

On Thu, Jun 13, 2024 at 07:24:10AM +0000, Masahiro.Ikeda@nttdata.com wrote:
> Thanks for your response. Please take a look at the attached patch.
> I've confirmed that it passes all tests.

Thanks for the patch.  Will check and apply.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: Doc: fix a description regarding WAL summarizer on glossary page
@ 2024-06-14 03:52  Masahiro Ikeda <ikedamsh@oss.nttdata.com>
  parent: Michael Paquier <michael@paquier.xyz>
  0 siblings, 0 replies; 5+ messages in thread

From: Masahiro Ikeda @ 2024-06-14 03:52 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; +Cc: Masahiro.Ikeda@nttdata.com; pgsql-hackers@lists.postgresql.org; Masao.Fujii@nttdata.com

On 2024-06-13 17:01, Michael Paquier wrote:
> On Thu, Jun 13, 2024 at 07:24:10AM +0000, Masahiro.Ikeda@nttdata.com 
> wrote:
>> Thanks for your response. Please take a look at the attached patch.
>> I've confirmed that it passes all tests.
> 
> Thanks for the patch.  Will check and apply.

Thanks for applying.

Regards,
-- 
Masahiro Ikeda
NTT DATA CORPORATION





^ permalink  raw  reply  [nested|flat] 5+ messages in thread

end of thread, other threads:[~2024-06-14 03:52 UTC | newest]

Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2024-06-11 09:06 Doc: fix a description regarding WAL summarizer on glossary page Masahiro Ikeda <ikedamsh@oss.nttdata.com>
2024-06-11 22:52 ` Michael Paquier <michael@paquier.xyz>
2024-06-13 07:24   ` Masahiro.Ikeda@nttdata.com
2024-06-13 08:01     ` Michael Paquier <michael@paquier.xyz>
2024-06-14 03:52       ` Masahiro Ikeda <ikedamsh@oss.nttdata.com>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox