public inbox for [email protected]
help / color / mirror / Atom feedFrom: Koshino Taiki <[email protected]>
To: [email protected] <[email protected]>
Subject: Re: Patch for fixing doc about some parameters.
Date: Fri, 4 Jul 2025 06:15:22 +0000
Message-ID: <TYYP286MB29311B5F79DA03F39C1B551B9443A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM> (raw)
In-Reply-To: <[email protected]>
References: <TYYP286MB2931EEDED823172BB0AE7D659440A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM>
<[email protected]>
Thank you for reviewing.
I removed the whitespace.
And I changed the commit title to
"Doc: fix documentation for enum parameters reported as
strings"
"Doc: fix documentation for parameters that are not
reflected by reload."
After receiving feedback from Peng-san, I will create a patch again.
Taiki Koshino<[email protected]>
SRA OSS K.K.
TEL: 03-5979-2701 FAX: 03-5979-2702
URL: https://www.sraoss.co.jp/
________________________________
差出人: Tatsuo Ishii <[email protected]>
送信日時: 2025年7月2日 20:27
宛先: Koshino Taiki <[email protected]>
CC: [email protected] <[email protected]>
件名: Re: Patch for fixing doc about some parameters.
> Fixed mistakes in the documentation for parameters.
>
> "v1-0001-Fixed-documentation-for-parameters-that-are-not-r.patch"
> is a patch for ticket #10954
> "Test all the configuration parameters if reload is required."
There's one trainling whitespace.
$ git apply ~/v1-0001-Fixed-documentation-for-parameters-that-are-not-r.patch
/home/t-ishii/v1-0001-Fixed-documentation-for-parameters-that-are-not-r.patch:39: trailing whitespace.
このパラメータはサーバ起動時にのみ設定可能です。
warning: 1 line adds whitespace errors.
> Subject: [PATCH v2] Fixed documentation for parameters that are not reflected
by reload.
This comes from the commit title "Fixed documentation for parameters
that are not reflected by reload." We usually add "Doc:" prefix to the
commit header if the changes are only for documentations. Also "Fixed"
seems unnatural as a commit header. Instead use "fix". So something
like "Doc: fix documentation for parameters that are not reflected by
reload." is better,
> "v1-0001-Fix-documentation-for-enum-parameters-reported-as"
> is for ticket #8397
Please add "Doc:" prefix to the commit title as well.
#8397 is an internal number and you'd better to remove it.
Other than that, the patch looks good to me.
Best regards,
--
Tatsuo Ishii
SRA OSS K.K.
English: http://www.sraoss.co.jp/index_en/
Japanese:http://www.sraoss.co.jp
Attachments:
[application/octet-stream] v2-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch (6.9K, 3-v2-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch)
download | inline diff:
From b3f50f69c2f8f55847620d50886a5a1f72cdc60f Mon Sep 17 00:00:00 2001
From: Taiki Koshino <[email protected]>
Date: Thu, 3 Jul 2025 09:03:09 +0900
Subject: [PATCH v2] Doc: fix documentation for enum parameters reported as
strings
Fix documentations for 5 parameters.
Japanese docs too.
"log_standby_delay"
"log_backend_messages"
"wd_lifecheck_method"
"memqcache_method"
"disable_load_balance_on_write"
---
doc.ja/src/sgml/connection-pooling.sgml | 2 +-
doc.ja/src/sgml/loadbalance.sgml | 2 +-
doc.ja/src/sgml/memcache.sgml | 2 +-
doc.ja/src/sgml/stream-check.sgml | 2 +-
doc.ja/src/sgml/watchdog.sgml | 2 +-
doc/src/sgml/connection-pooling.sgml | 2 +-
doc/src/sgml/loadbalance.sgml | 2 +-
doc/src/sgml/memcache.sgml | 2 +-
doc/src/sgml/stream-check.sgml | 2 +-
doc/src/sgml/watchdog.sgml | 2 +-
10 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc.ja/src/sgml/connection-pooling.sgml b/doc.ja/src/sgml/connection-pooling.sgml
index 50b7a23c6..e9c8253c7 100644
--- a/doc.ja/src/sgml/connection-pooling.sgml
+++ b/doc.ja/src/sgml/connection-pooling.sgml
@@ -1214,7 +1214,7 @@ local0.* /var/log/pgpool.log
</varlistentry>
<varlistentry id="guc-log-backend-messages" xreflabel="log_backend_messages">
- <term><varname>log_backend_messages</varname> (<type>boolean</type>)
+ <term><varname>log_backend_messages</varname> (<type>enum</type>)
<indexterm>
<!--
<primary><varname>log_backend_messages</varname> configuration parameter</primary>
diff --git a/doc.ja/src/sgml/loadbalance.sgml b/doc.ja/src/sgml/loadbalance.sgml
index 670187180..87cfa8e97 100644
--- a/doc.ja/src/sgml/loadbalance.sgml
+++ b/doc.ja/src/sgml/loadbalance.sgml
@@ -1421,7 +1421,7 @@ app_name_redirect_preference_list > database_redirect_preference_list > us
</varlistentry>
<varlistentry id="guc-disable-load-balance-on-write" xreflabel="disable_load_balance_on_write">
- <term><varname>disable_load_balance_on_write</varname> (<type>string</type>)
+ <term><varname>disable_load_balance_on_write</varname> (<type>enum</type>)
<indexterm>
<!--
<primary><varname>disable_load_balance_on_write</varname> configuration parameter</primary>
diff --git a/doc.ja/src/sgml/memcache.sgml b/doc.ja/src/sgml/memcache.sgml
index 8267c89e0..41f5b6add 100644
--- a/doc.ja/src/sgml/memcache.sgml
+++ b/doc.ja/src/sgml/memcache.sgml
@@ -256,7 +256,7 @@
<variablelist>
<varlistentry id="guc-memqcache-method" xreflabel="memqcache_method">
- <term><varname>memqcache_method</varname> (<type>string</type>)
+ <term><varname>memqcache_method</varname> (<type>enum</type>)
<indexterm>
<!--
<primary><varname>memqcache_method</varname> configuration parameter</primary>
diff --git a/doc.ja/src/sgml/stream-check.sgml b/doc.ja/src/sgml/stream-check.sgml
index 7295faef9..58220741a 100644
--- a/doc.ja/src/sgml/stream-check.sgml
+++ b/doc.ja/src/sgml/stream-check.sgml
@@ -388,7 +388,7 @@ GRANT pg_monitor TO sr_check_user;
</varlistentry>
<varlistentry id="guc-log-standby-delay" xreflabel="log_standby_delay">
- <term><varname>log_standby_delay</varname> (<type>string</type>)
+ <term><varname>log_standby_delay</varname> (<type>enum</type>)
<indexterm>
<!--
<primary><varname>log_standby_delay</varname> configuration parameter</primary>
diff --git a/doc.ja/src/sgml/watchdog.sgml b/doc.ja/src/sgml/watchdog.sgml
index ceb546079..c84ba4906 100644
--- a/doc.ja/src/sgml/watchdog.sgml
+++ b/doc.ja/src/sgml/watchdog.sgml
@@ -1320,7 +1320,7 @@
<variablelist>
<varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method">
- <term><varname>wd_lifecheck_method</varname> (<type>string</type>)
+ <term><varname>wd_lifecheck_method</varname> (<type>enum</type>)
<indexterm>
<!--
<primary><varname>wd_lifecheck_method</varname> configuration parameter</primary>
diff --git a/doc/src/sgml/connection-pooling.sgml b/doc/src/sgml/connection-pooling.sgml
index 9f6a751cd..f6ebb773c 100644
--- a/doc/src/sgml/connection-pooling.sgml
+++ b/doc/src/sgml/connection-pooling.sgml
@@ -791,7 +791,7 @@
</varlistentry>
<varlistentry id="guc-log-backend-messages" xreflabel="log_backend_messages">
- <term><varname>log_backend_messages</varname> (<type>boolean</type>)
+ <term><varname>log_backend_messages</varname> (<type>enum</type>)
<indexterm>
<primary><varname>log_backend_messages</varname> configuration parameter</primary>
</indexterm>
diff --git a/doc/src/sgml/loadbalance.sgml b/doc/src/sgml/loadbalance.sgml
index 2b186467a..ee19fabeb 100644
--- a/doc/src/sgml/loadbalance.sgml
+++ b/doc/src/sgml/loadbalance.sgml
@@ -1039,7 +1039,7 @@ app_name_redirect_preference_list > database_redirect_preference_list > us
</varlistentry>
<varlistentry id="guc-disable-load-balance-on-write" xreflabel="disable_load_balance_on_write">
- <term><varname>disable_load_balance_on_write</varname> (<type>string</type>)
+ <term><varname>disable_load_balance_on_write</varname> (<type>enum</type>)
<indexterm>
<primary><varname>disable_load_balance_on_write</varname> configuration parameter</primary>
</indexterm>
diff --git a/doc/src/sgml/memcache.sgml b/doc/src/sgml/memcache.sgml
index 9888b8865..49ac73595 100644
--- a/doc/src/sgml/memcache.sgml
+++ b/doc/src/sgml/memcache.sgml
@@ -192,7 +192,7 @@
<variablelist>
<varlistentry id="guc-memqcache-method" xreflabel="memqcache_method">
- <term><varname>memqcache_method</varname> (<type>string</type>)
+ <term><varname>memqcache_method</varname> (<type>enum</type>)
<indexterm>
<primary><varname>memqcache_method</varname> configuration parameter</primary>
</indexterm>
diff --git a/doc/src/sgml/stream-check.sgml b/doc/src/sgml/stream-check.sgml
index 8515b6510..90fd61820 100644
--- a/doc/src/sgml/stream-check.sgml
+++ b/doc/src/sgml/stream-check.sgml
@@ -310,7 +310,7 @@ GRANT pg_monitor TO sr_check_user;
</varlistentry>
<varlistentry id="guc-log-standby-delay" xreflabel="log_standby_delay">
- <term><varname>log_standby_delay</varname> (<type>string</type>)
+ <term><varname>log_standby_delay</varname> (<type>enum</type>)
<indexterm>
<primary><varname>log_standby_delay</varname> configuration parameter</primary>
</indexterm>
diff --git a/doc/src/sgml/watchdog.sgml b/doc/src/sgml/watchdog.sgml
index 0a238f302..2588a0a9b 100644
--- a/doc/src/sgml/watchdog.sgml
+++ b/doc/src/sgml/watchdog.sgml
@@ -951,7 +951,7 @@ pgpool_port2 = 9999
<variablelist>
<varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method">
- <term><varname>wd_lifecheck_method</varname> (<type>string</type>)
+ <term><varname>wd_lifecheck_method</varname> (<type>enum</type>)
<indexterm>
<primary><varname>wd_lifecheck_method</varname> configuration parameter</primary>
</indexterm>
--
2.43.5
[application/octet-stream] v2-0001-Doc-fix-documentation-for-parameters-that-are-not.patch (2.8K, 4-v2-0001-Doc-fix-documentation-for-parameters-that-are-not.patch)
download | inline diff:
From 61c8936feb6579e7ff056e279a5916c19a1b191b Mon Sep 17 00:00:00 2001
From: Taiki Koshino <[email protected]>
Date: Thu, 3 Jul 2025 09:09:16 +0900
Subject: [PATCH v2] Doc: fix documentation for parameters that are not
reflected by reload.
"authentication_timeout" and "memqcache_oiddir" is not reflected by reload.
The documentation is changed to "This parameter can only be set at server start.".
Japanese doc too.
---
doc.ja/src/sgml/connection-settings.sgml | 2 +-
doc.ja/src/sgml/memcache.sgml | 2 +-
doc/src/sgml/connection-settings.sgml | 3 +--
doc/src/sgml/memcache.sgml | 2 +-
4 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/doc.ja/src/sgml/connection-settings.sgml b/doc.ja/src/sgml/connection-settings.sgml
index 9eac21f1c..f748f4cb4 100644
--- a/doc.ja/src/sgml/connection-settings.sgml
+++ b/doc.ja/src/sgml/connection-settings.sgml
@@ -700,7 +700,7 @@
<!--
This parameter can be changed by reloading the <productname>Pgpool-II</> configurations.
-->
- このパラメータは<productname>Pgpool-II</>の設定を再読み込みすることで変更可能です。
+ このパラメータはサーバ起動時にのみ設定可能です。
</para>
</listitem>
</varlistentry>
diff --git a/doc.ja/src/sgml/memcache.sgml b/doc.ja/src/sgml/memcache.sgml
index 26e3b79bf..6327cc207 100644
--- a/doc.ja/src/sgml/memcache.sgml
+++ b/doc.ja/src/sgml/memcache.sgml
@@ -667,7 +667,7 @@
<!--
This parameter can be changed by reloading the <productname>Pgpool-II</> configurations.
-->
- このパラメータは<productname>Pgpool-II</>の設定を再読み込みすることで変更可能です。
+ このパラメータはサーバ起動時にのみ設定可能です。
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/connection-settings.sgml b/doc/src/sgml/connection-settings.sgml
index 33e1ce53a..262c76d05 100644
--- a/doc/src/sgml/connection-settings.sgml
+++ b/doc/src/sgml/connection-settings.sgml
@@ -450,8 +450,7 @@
Default value is 60.
</para>
<para>
- This parameter can be changed by reloading
- the <productname>Pgpool-II</productname> configurations.
+ This parameter can only be set at server start.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/memcache.sgml b/doc/src/sgml/memcache.sgml
index b1a48ed7d..9888b8865 100644
--- a/doc/src/sgml/memcache.sgml
+++ b/doc/src/sgml/memcache.sgml
@@ -466,7 +466,7 @@
</para>
</note>
<para>
- This parameter can be changed by reloading the <productname>Pgpool-II</productname> configurations.
+ This parameter can only be set at server start.
</para>
</listitem>
</varlistentry>
--
2.43.5
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected]
Subject: Re: Patch for fixing doc about some parameters.
In-Reply-To: <TYYP286MB29311B5F79DA03F39C1B551B9443A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox