public inbox for [email protected]  
help / color / mirror / Atom feed
From: Koshino Taiki <[email protected]>
To: Bo Peng <[email protected]>
To: [email protected] <[email protected]>
Subject: Re: Patch for fixing doc about some parameters.
Date: Wed, 9 Jul 2025 01:18:14 +0000
Message-ID: <TYYP286MB2931801B8076223F042D879A9449A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM> (raw)
In-Reply-To: <TYWP286MB2633CAED55BC22ED763B4921F242A@TYWP286MB2633.JPNP286.PROD.OUTLOOK.COM>
References: <TYYP286MB2931EEDED823172BB0AE7D659440A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM>
	<[email protected]>
	<TYYP286MB29311B5F79DA03F39C1B551B9443A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM>
	<TYWP286MB2633CAED55BC22ED763B4921F242A@TYWP286MB2633.JPNP286.PROD.OUTLOOK.COM>

Peng-san.

Thank you for reviewing.
I improved patches.

--------------------------------------
v3-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch.
--------------------------------------

For the following parameters:

    log_standby_delay
    wd_lifecheck_method
    memqcache_method
    disable_load_balance_on_write

I deleted '' on config file and document.

------------------------------------------
v3-0001-Doc-fix-documentation-for-parameters-that-are-not.patch
------------------------------------------

I fixed the configuration file to add the description such as "(change requires restart)".

Taiki Koshino<[email protected]>
SRA OSS K.K.
TEL: 03-5979-2701 FAX: 03-5979-2702
URL: https://www.sraoss.co.jp/

________________________________
差出人: Bo Peng <[email protected]>
送信日時: 2025年7月4日 16:59
宛先: Koshino Taiki <[email protected]>; [email protected] <[email protected]>
件名: Re: Patch for fixing doc about some parameters.

Koshino-san,

Thank you for your patch.
I have reviewed your patch and have a few comments.

--------------------------------------
v2-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch.
--------------------------------------

For the following parameters:

    log_standby_delay
    wd_lifecheck_method
    memqcache_method
    disable_load_balance_on_write

In the documentation, their types have been correctly changed to enum, which is good.
However, in both the configuration file examples and the parameter description sections,
these values are still written as strings (enclosed in single quotes).

For example:

(config file)
#wd_lifecheck_method = 'heartbeat'

(Document)
wd_lifecheck_method (enum)
    Specifies the method of life check. This can be either of 'heartbeat' (default), 'query' or 'external'.

This is no big issue since Pgpool-II accepts string values (e.g. 'foo') even for enum parameters.
However, it's a bit confusing, so I think it should be fixed.

For example:

#wd_lifecheck_method = heartbeat
                                                 # Method of watchdog lifecheck (heartbeat or query or external)

wd_lifecheck_method (enum)
    Specifies the method of life check. This can be either of <literal>heartbeat</literal> (default), <literal>query</literal> or <literal>external</literal>.

------------------------------------------
v2-0001-Doc-fix-documentation-for-parameters-that-are-not.patch
------------------------------------------

I think we should also fix the configuration file to add the description such as "(change requires restart)".

For example:

#authentication_timeout = 1min
                                   # Delay in seconds to complete client authentication
                                   # 0 means no timeout.
                                   # (change requires restart)

________________________________________
差出人: Koshino Taiki <[email protected]>
送信: 2025 年 7 月 4 日 (金曜日) 15:15
宛先: [email protected] <[email protected]>
件名: Re: Patch for fixing doc about some parameters.

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-2702URL: 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 parametersthat are not reflected by reload." We usually add "Doc:" prefix to thecommit header if the changes are only for documentations. Also "Fixed"seems unnatural as a commit header. Instead use "fix". So somethinglike "Doc: fix documentation for parameters that are not reflected byreload." is better,> "v1-0001-Fix-documentation-for-enum-parameters-reported-as"> is for ticket #8397Please 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 IshiiSRA OSS K.K.English: http://www.sraoss.co.jp/index_en/Japanese:http://www.sraoss.co.jp


Attachments:

  [application/octet-stream] v3-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch (19.3K, 3-v3-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch)
  download | inline diff:
From b5c5951435ec91e038558e8e297d17fa831dab28 Mon Sep 17 00:00:00 2001
From: Taiki Koshino <[email protected]>
Date: Tue, 8 Jul 2025 15:52:10 +0900
Subject: [PATCH v3] 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           | 10 +++----
 doc.ja/src/sgml/stream-check.sgml       |  8 +++---
 doc.ja/src/sgml/watchdog.sgml           | 10 +++----
 doc/src/sgml/connection-pooling.sgml    |  2 +-
 doc/src/sgml/loadbalance.sgml           |  2 +-
 doc/src/sgml/memcache.sgml              |  8 +++---
 doc/src/sgml/stream-check.sgml          |  8 +++---
 doc/src/sgml/watchdog.sgml              |  6 ++---
 src/sample/pgpool.conf.sample-stream    | 36 ++++++++++++-------------
 11 files changed, 47 insertions(+), 47 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 &gt; database_redirect_preference_list &gt; 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 6327cc207..0a6665138 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>
@@ -290,7 +290,7 @@
 
        <tbody>
 	<row>
-	 <entry><literal>'shmem'</literal></entry>
+	 <entry><literal>shmem</literal></entry>
 	 <!--
 	 <entry>Use shared memory</entry>
 	 -->
@@ -298,7 +298,7 @@
 	</row>
 
 	<row>
-	 <entry><literal>'memcached'</literal></entry>
+	 <entry><literal>memcached</literal></entry>
 	 <!--
 	 <entry>Use <ulink url="http://memcached.org/">memcached</ulink></entry>
 	 -->
@@ -338,9 +338,9 @@
 
      <para>
       <!--
-      Default is <literal>'shmem'</literal>.
+      Default is <literal>shmem</literal>.
       -->
-      デフォルトは<literal>'shmem'</literal>です。
+      デフォルトは<literal>shmem</literal>です。
      </para>
 
      <para>
diff --git a/doc.ja/src/sgml/stream-check.sgml b/doc.ja/src/sgml/stream-check.sgml
index 7295faef9..4b3a85e69 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>
@@ -426,7 +426,7 @@ GRANT pg_monitor TO sr_check_user;
 
       <tbody>
        <row>
-	<entry><literal>'none'</literal></entry>
+	<entry><literal>none</literal></entry>
 	<!--
 	<entry>Never log the standby delay</entry>
 	-->
@@ -434,7 +434,7 @@ GRANT pg_monitor TO sr_check_user;
        </row>
 
        <row>
-	<entry><literal>'always'</literal></entry>
+	<entry><literal>always</literal></entry>
 	<!--
 	<entry>Log the standby delay, every time the replication delay is checked</entry>
 	-->
@@ -442,7 +442,7 @@ GRANT pg_monitor TO sr_check_user;
        </row>
 
        <row>
-	<entry><literal>'if_over_threshold'</literal></entry>
+	<entry><literal>if_over_threshold</literal></entry>
 	<!--
 	<entry>Only log the standby delay, when it exceeds <xref linkend="guc-delay-threshold"> value</entry>
 	-->
diff --git a/doc.ja/src/sgml/watchdog.sgml b/doc.ja/src/sgml/watchdog.sgml
index ceb546079..b4eff8db6 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>
@@ -1331,11 +1331,11 @@
     <listitem>
      <para>
       <!--
-      Specifies the method of life check. This can be either of <literal>'heartbeat'</literal> (default),
-      <literal>'query'</literal> or <literal>'external'</literal>.
+      Specifies the method of life check. This can be either of <literal>heartbeat</literal> (default),
+      <literal>query</literal> or <literal>external</literal>.
       -->
       死活監視の方法を指定します。
-      指定できる値は <literal>'heartbeat'</literal> (デフォルト)、<literal>'query'</literal>、または<literal>'external'</literal> です。
+      指定できる値は <literal>heartbeat</literal> (デフォルト)、<literal>query</literal>、または<literal>external</literal> です。
      </para>
      <para>
       <!--
@@ -1345,7 +1345,7 @@
       If there are no signal for a certain period, watchdog regards is as failure
       of the <productname>Pgpool-II</productname> .
       -->
-      <literal>'heartbeat'</literal>を指定した場合には、監視は「ハートビートモード」で行われます。
+      <literal>heartbeat</literal>を指定した場合には、監視は「ハートビートモード」で行われます。
       watchdog は一定間隔でハートビート信号(UDP パケット)を他の<productname>Pgpool-II</productname>へ送信します。
       またwatchdogは他の<productname>Pgpool-II</productname>から送られてくる信号を受信します。
       これが一定時間以上途絶えた場合にはその<productname>Pgpool-II</productname>に障害が発生したと判断します。
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 &gt; database_redirect_preference_list &gt; 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..065de41ee 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>
@@ -215,12 +215,12 @@
 
        <tbody>
 	<row>
-	 <entry><literal>'shmem'</literal></entry>
+	 <entry><literal>shmem</literal></entry>
 	 <entry>Use shared memory</entry>
 	</row>
 
 	<row>
-	 <entry><literal>'memcached'</literal></entry>
+	 <entry><literal>memcached</literal></entry>
 	 <entry>Use <ulink url="http://memcached.org/">memcached</ulink></entry>
 	</row>
 
@@ -245,7 +245,7 @@
       If you are not sure which memqcache_method to be used, start with <varname>shmem</varname>.
      </para>
      <para>
-      Default is <literal>'shmem'</literal>.
+      Default is <literal>shmem</literal>.
      </para>
 
      <para>
diff --git a/doc/src/sgml/stream-check.sgml b/doc/src/sgml/stream-check.sgml
index 8515b6510..d2ca3ca49 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>
@@ -334,17 +334,17 @@ GRANT pg_monitor TO sr_check_user;
 
       <tbody>
        <row>
-	<entry><literal>'none'</literal></entry>
+	<entry><literal>none</literal></entry>
 	<entry>Never log the standby delay</entry>
        </row>
 
        <row>
-	<entry><literal>'always'</literal></entry>
+	<entry><literal>always</literal></entry>
 	<entry>Log the standby delay if it's greater than 0, every time the replication delay is checked</entry>
        </row>
 
        <row>
-	<entry><literal>'if_over_threshold'</literal></entry>
+	<entry><literal>if_over_threshold</literal></entry>
 	<entry>Only log the standby delay, when it exceeds <xref linkend="guc-delay-threshold"> or <xref linkend="guc-delay-threshold-by-time"> value (the default)</entry>
        </row>
       </tbody>
diff --git a/doc/src/sgml/watchdog.sgml b/doc/src/sgml/watchdog.sgml
index 0a238f302..86812ce32 100644
--- a/doc/src/sgml/watchdog.sgml
+++ b/doc/src/sgml/watchdog.sgml
@@ -951,15 +951,15 @@ 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>
     </term>
     <listitem>
      <para>
-      Specifies the method of life check. This can be either of <literal>'heartbeat'</literal> (default),
-      <literal>'query'</literal> or <literal>'external'</literal>.
+      Specifies the method of life check. This can be either of <literal>heartbeat</literal> (default),
+      <literal>query</literal> or <literal>external</literal>.
      </para>
      <para>
       <literal>heartbeat</literal>: In this mode, watchdog sends the heartbeat signals (<acronym>UDP</acronym> packets)
diff --git a/src/sample/pgpool.conf.sample-stream b/src/sample/pgpool.conf.sample-stream
index 9478198d7..a3bd6e163 100644
--- a/src/sample/pgpool.conf.sample-stream
+++ b/src/sample/pgpool.conf.sample-stream
@@ -262,7 +262,7 @@ backend_clustering_mode = 'streaming_replication'
                                    # Log any backend messages
                                    # Valid values are none, terse and verbose
 
-#log_standby_delay = 'if_over_threshold'
+#log_standby_delay = if_over_threshold
                                    # Log standby delay
                                    # Valid values are combinations of always,
                                    # if_over_threshold, none
@@ -457,33 +457,33 @@ backend_clustering_mode = 'streaming_replication'
                                    # If off, SQL comments effectively prevent the judgment
                                    # (pre 3.4 behavior).
 
-#disable_load_balance_on_write = 'transaction'
+#disable_load_balance_on_write = transaction
                                    # Load balance behavior when write query is issued
                                    # in an explicit transaction.
                                    #
                                    # Valid values:
                                    #
-                                   # 'transaction' (default):
+                                   # transaction (default):
                                    #     if a write query is issued, subsequent
                                    #     read queries will not be load balanced
                                    #     until the transaction ends.
                                    #
-                                   # 'trans_transaction':
+                                   # trans_transaction:
                                    #     if a write query is issued, subsequent
                                    #     read queries in an explicit transaction
                                    #     will not be load balanced until the session ends.
                                    #
-                                   # 'dml_adaptive':
+                                   # dml_adaptive:
                                    #     Queries on the tables that have already been
                                    #     modified within the current explicit transaction will
                                    #     not be load balanced until the end of the transaction.
                                    #
-                                   # 'always':
+                                   # always:
                                    #     if a write query is issued, read queries will
                                    #     not be load balanced until the session ends.
                                    #
                                    # Note that any query not in an explicit transaction
-                                   # is not affected by the parameter except 'always'.
+                                   # is not affected by the parameter except always.
 
 #dml_adaptive_object_relationship_list= ''
                                    # comma separated list of object pairs
@@ -494,7 +494,7 @@ backend_clustering_mode = 'streaming_replication'
                                    # example: 'tb_t1:tb_t2,insert_tb_f_func():tb_f,tb_v:my_view'
                                    # Note: function name in this list must also be present in
                                    # the write_function_list
-                                   # only valid for disable_load_balance_on_write = 'dml_adaptive'.
+                                   # only valid for disable_load_balance_on_write = dml_adaptive.
 
 #statement_level_load_balance = off
                                    # Enables statement level load balancing
@@ -855,8 +855,8 @@ backend_clustering_mode = 'streaming_replication'
                                     # '' to disable monitoring
                                     # (change requires restart)
 
-#wd_lifecheck_method = 'heartbeat'
-                                    # Method of watchdog lifecheck ('heartbeat' or 'query' or 'external')
+#wd_lifecheck_method = heartbeat
+                                    # Method of watchdog lifecheck (heartbeat or query or external)
                                     # (change requires restart)
 #wd_interval = 10
                                     # lifecheck interval (sec) > 0
@@ -964,27 +964,27 @@ backend_clustering_mode = 'streaming_replication'
 #memory_cache_enabled = off
                                    # If on, use the memory cache functionality, off by default
                                    # (change requires restart)
-#memqcache_method = 'shmem'
-                                   # Cache storage method. either 'shmem'(shared memory) or
-                                   # 'memcached'. 'shmem' by default
+#memqcache_method = shmem
+                                   # Cache storage method. either shmem(shared memory) or
+                                   # memcached. shmem by default
                                    # (change requires restart)
 #memqcache_memcached_host = 'localhost'
                                    # Memcached host name or IP address. Mandatory if
-                                   # memqcache_method = 'memcached'.
+                                   # memqcache_method = memcached.
                                    # Defaults to localhost.
                                    # (change requires restart)
 #memqcache_memcached_port = 11211
-                                   # Memcached port number. Mandatory if memqcache_method = 'memcached'.
+                                   # Memcached port number. Mandatory if memqcache_method = memcached.
                                    # Defaults to 11211.
                                    # (change requires restart)
 #memqcache_total_size = 64MB
                                    # Total memory size in bytes for storing memory cache.
-                                   # Mandatory if memqcache_method = 'shmem'.
+                                   # Mandatory if memqcache_method = shmem.
                                    # Defaults to 64MB.
                                    # (change requires restart)
 #memqcache_max_num_cache = 1000000
                                    # Total number of cache entries. Mandatory
-                                   # if memqcache_method = 'shmem'.
+                                   # if memqcache_method = shmem.
                                    # Each cache entry consumes 48 bytes on shared memory.
                                    # Defaults to 1,000,000(45.8MB).
                                    # (change requires restart)
@@ -1002,7 +1002,7 @@ backend_clustering_mode = 'streaming_replication'
                                    # Must be smaller than memqcache_cache_block_size. Defaults to 400KB.
                                    # (change requires restart)
 #memqcache_cache_block_size = 1MB
-                                   # Cache block size in bytes. Mandatory if memqcache_method = 'shmem'.
+                                   # Cache block size in bytes. Mandatory if memqcache_method = shmem.
                                    # Defaults to 1MB.
                                    # (change requires restart)
 #memqcache_oiddir = '/var/log/pgpool/oiddir'
-- 
2.43.5



  [application/octet-stream] v3-0001-Doc-fix-documentation-for-parameters-that-are-not.patch (3.4K, 4-v3-0001-Doc-fix-documentation-for-parameters-that-are-not.patch)
  download | inline diff:
From e7693001861a6e1a3bc0bc040689d94217f3e73e Mon Sep 17 00:00:00 2001
From: Taiki Koshino <[email protected]>
Date: Tue, 8 Jul 2025 15:06:36 +0900
Subject: [PATCH v3] 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 +-
 src/sample/pgpool.conf.sample-stream     | 1 +
 5 files changed, 5 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>
diff --git a/src/sample/pgpool.conf.sample-stream b/src/sample/pgpool.conf.sample-stream
index 217e9d055..9478198d7 100644
--- a/src/sample/pgpool.conf.sample-stream
+++ b/src/sample/pgpool.conf.sample-stream
@@ -114,6 +114,7 @@ backend_clustering_mode = 'streaming_replication'
 #authentication_timeout = 1min
                                    # Delay in seconds to complete client authentication
                                    # 0 means no timeout.
+                                   # (change requires restart)
 
 #allow_clear_text_frontend_auth = off
                                    # Allow Pgpool-II to use clear text password authentication
-- 
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], [email protected]
  Subject: Re: Patch for fixing doc about some parameters.
  In-Reply-To: <TYYP286MB2931801B8076223F042D879A9449A@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