From 13259b5a60d2fb09b7b1eabbfae335a1e2c41779 Mon Sep 17 00:00:00 2001
From: Tatsuo Ishii <ishii@sraoss.co.jp>
Date: Wed, 9 Dec 2020 11:48:57 +0900
Subject: [PATCH] Doc: fix misleading description about reloading.

While taking care of this:
https://www.pgpool.net/mantisbt/view.php?id=671

I noticed our documentation gives misleading explanation about pgpool
behavior when pgpool.conf is reloaded:

https://www.pgpool.net/docs/latest/en/html/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE
The configuration file is reread whenever the main server process
receives a SIGHUP signal; this signal is most easily sent by running
pgpool reload from the command line. The main pgpool process also
propagates this signal to all its child processes, so that existing
sessions also adopt the new values. Some parameters can only be set at
server start; any changes to their entries in the configuration file
will be ignored until the server is restarted. Invalid parameter
settings in the configuration file are likewise ignored (but logged)
during SIGHUP processing.

The reality is, new parameter values will not be reflected to existing
sessions. They will be reflected when new session is
established. Reloading new config values is handled by
check_config_reload() in src/protocol/child.c. It's only called in the
beginning of establishing client sessions. It will not be called while
the session continues. Changing the place to call the function so that
it is called within a session maybe possible. But it will need
careful investigation to not break existing logic depending on
parameters.

Discussion: https://www.pgpool.net/pipermail/pgpool-hackers/2020-December/003856.html
---
 doc.ja/src/sgml/config.sgml | 4 ++--
 doc/src/sgml/config.sgml    | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc.ja/src/sgml/config.sgml b/doc.ja/src/sgml/config.sgml
index f55ca04eb..a2a3ea2d2 100644
--- a/doc.ja/src/sgml/config.sgml
+++ b/doc.ja/src/sgml/config.sgml
@@ -214,7 +214,7 @@
     receives a <systemitem>SIGHUP</> signal; this signal is most easily
     sent by running <literal>pgpool reload</> from the command line. The main
     pgpool process also propagates this signal to all its child
-    processes, so that existing sessions also adopt the new values.
+    processes, so that next sessions also adopt the new values.
     Some parameters can only be set at server start; any changes to their
     entries in the configuration file will be ignored until the server is restarted.
     Invalid parameter settings in the configuration file are likewise
@@ -222,7 +222,7 @@
     -->
     設定ファイルはメインサーバプロセスが<systemitem>SIGHUP</>信号を受け取ると何時でも 再読み込みされます。
     手っ取り早く行なうには、コマンドラインから<literal>pgpool reload</>を実行します。
-    メインpgpoolプロセスは同時にこの信号を、現存のセッションが同様に新しい値を入手できるように、全ての子プロセスに伝播します。
+    メインpgpoolプロセスは同時にこの信号を、次のセッションが同様に新しい値を入手できるように、全ての子プロセスに伝播します。
     いくつかのパラメータはサーバの起動時のみ設定されます;
     設定ファイル中のそれらのエントリのいかなる変更も、サーバが再起動されるまで無視されます。
     設定ファイル内で無効なパラメータが設定された場合は同様に（ログには残りますが）<systemitem>SIGHUP</>処理中に無視されます。
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 6d0c8fbe2..730cf7e40 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -138,7 +138,7 @@
     receives a <systemitem>SIGHUP</> signal; this signal is most easily
     sent by running <literal>pgpool reload</> from the command line. The main
     pgpool process also propagates this signal to all its child
-    processes, so that existing sessions also adopt the new values.
+    processes, so that next sessions also adopt the new values.
     Some parameters can only be set at server start; any changes to their
     entries in the configuration file will be ignored until the server is restarted.
     Invalid parameter settings in the configuration file are likewise
-- 
2.39.5