Re: Patch for fixing doc about some parameters.

From: Koshino Taiki <koshino(at)sraoss(dot)co(dot)jp>
To: "pgpool-hackers(at)lists(dot)postgresql(dot)org" <pgpool-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Patch for fixing doc about some parameters.
Date: 2025-07-04 06:15:22
Message-ID: TYYP286MB29311B5F79DA03F39C1B551B9443A@TYYP286MB2931.JPNP286.PROD.OUTLOOK.COM
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgpool-hackers

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<koshino(at)sraoss(dot)co(dot)jp>
SRA OSS K.K.
TEL: 03-5979-2701 FAX: 03-5979-2702
URL: https://www.sraoss.co.jp/

________________________________
差出人: Tatsuo Ishii <ishii(at)postgresql(dot)org>
送信日時: 2025年7月2日 20:27
宛先: Koshino Taiki <koshino(at)sraoss(dot)co(dot)jp>
CC: pgpool-hackers(at)lists(dot)postgresql(dot)org <pgpool-hackers(at)lists(dot)postgresql(dot)org>
件名: 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

Attachment Content-Type Size
v2-0001-Doc-fix-documentation-for-enum-parameters-reporte.patch application/octet-stream 6.9 KB
v2-0001-Doc-fix-documentation-for-parameters-that-are-not.patch application/octet-stream 2.8 KB

In response to

Responses

Browse pgpool-hackers by date

  From Date Subject
Next Message Bo Peng 2025-07-04 07:59:01 Re: Patch for fixing doc about some parameters.
Previous Message Tatsuo Ishii 2025-07-02 11:27:13 Re: Patch for fixing doc about some parameters.