doc: mention pg_reload_conf() in pg_hba.conf documentation

Started by Ian Barwickover 6 years ago3 messages

Ian Barwick

ian.barwick@2ndquadrant.com

over 6 years ago

1 attachment(s)

I noticed the documentation for pg_hba.conf:

https://www.postgresql.org/docs/current/auth-pg-hba-conf.html

says:

you will need to signal the postmaster (using pg_ctl reload or kill -HUP) to
make it re-read the file.

It would be useful to mention pg_reload_conf() as another option here, as done
elsewhere in the docs.

Patch with suggested change attached.

Regards

Ian Barwick

--
Ian Barwick https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

Attachments:

doc-pg_hba-pg_reload_conf.v1.patchtext/x-patch; name=doc-pg_hba-pg_reload_conf.v1.patchDownload

diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml
new file mode 100644
index 3ed74d8..c90ca0b
*** a/doc/src/sgml/client-auth.sgml
--- b/doc/src/sgml/client-auth.sgml
*************** hostnogssenc <replaceable>database</repl
*** 650,657 ****
     <systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
     signal. If you edit the file on an
     active system, you will need to signal the postmaster
!    (using <literal>pg_ctl reload</literal> or <literal>kill -HUP</literal>) to make it
!    re-read the file.
    </para>
  
    <note>
--- 650,658 ----
     <systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
     signal. If you edit the file on an
     active system, you will need to signal the postmaster
!    (using <literal>pg_ctl reload</literal>, <literal>kill -HUP</literal>
!    or by calling the SQL function <function>pg_reload_conf()</function>)
!    to make it re-read the file.
    </para>
  
    <note>

Bruce Momjian

bruce@momjian.us

over 6 years ago

In reply to: Ian Barwick (#1)

1 attachment(s)

Re: doc: mention pg_reload_conf() in pg_hba.conf documentation

On Mon, Jul 15, 2019 at 12:47:18PM +0900, Ian Barwick wrote:

Hi

I noticed the documentation for pg_hba.conf:

https://www.postgresql.org/docs/current/auth-pg-hba-conf.html

says:

you will need to signal the postmaster (using pg_ctl reload or kill -HUP) to
make it re-read the file.

It would be useful to mention pg_reload_conf() as another option here, as done
elsewhere in the docs.

Patch with suggested change attached.

Oh, good point. Not sure how we missed that, but I had to fix a mention
in pg_hba.conf a while ago too. Also, there were two mentions in that
file, so I fixed them both with the attached patch. Backpatched to 9.4.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +

Attachments:

1text/plain; charset=us-asciiDownload

diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml
new file mode 100644
index 3ed74d8..fada728
*** a/doc/src/sgml/client-auth.sgml
--- b/doc/src/sgml/client-auth.sgml
*************** hostnogssenc <replaceable>database</repl
*** 650,657 ****
     <systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
     signal. If you edit the file on an
     active system, you will need to signal the postmaster
!    (using <literal>pg_ctl reload</literal> or <literal>kill -HUP</literal>) to make it
!    re-read the file.
    </para>
  
    <note>
--- 650,658 ----
     <systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
     signal. If you edit the file on an
     active system, you will need to signal the postmaster
!    (using <literal>pg_ctl reload</literal>, calling the SQL function
!    <function>pg_reload_conf()</function>, or using <literal>kill
!    -HUP</literal>) to make it re-read the file.
    </para>
  
    <note>
*************** mymap   /^(.*)@otherdomain\.com$   guest
*** 871,878 ****
     <systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
     signal. If you edit the file on an
     active system, you will need to signal the postmaster
!    (using <literal>pg_ctl reload</literal> or <literal>kill -HUP</literal>) to make it
!    re-read the file.
    </para>
  
    <para>
--- 872,880 ----
     <systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
     signal. If you edit the file on an
     active system, you will need to signal the postmaster
!    (using <literal>pg_ctl reload</literal>, calling the SQL function
!    <function>pg_reload_conf()</function>, or using <literal>kill
!    -HUP</literal>) to make it re-read the file.
    </para>
  
    <para>

Ian Barwick

ian.barwick@2ndquadrant.com

over 6 years ago

In reply to: Bruce Momjian (#2)

Re: doc: mention pg_reload_conf() in pg_hba.conf documentation

On 7/16/19 10:09 AM, Bruce Momjian wrote:

On Mon, Jul 15, 2019 at 12:47:18PM +0900, Ian Barwick wrote:

Hi

I noticed the documentation for pg_hba.conf:

https://www.postgresql.org/docs/current/auth-pg-hba-conf.html

says:

you will need to signal the postmaster (using pg_ctl reload or kill -HUP) to
make it re-read the file.

It would be useful to mention pg_reload_conf() as another option here, as done
elsewhere in the docs.

Patch with suggested change attached.

Oh, good point. Not sure how we missed that, but I had to fix a mention
in pg_hba.conf a while ago too. Also, there were two mentions in that
file, so I fixed them both with the attached patch. Backpatched to 9.4.

Thanks!

I only noticed it because I was writing up some basic instructions for someone
not very familiar with Pg, and cross-referencing to the documentation.

Regards

Ian Barwick

--
Ian Barwick https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services