pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: PG Doc comments form <noreply@postgresql.org>
To: pgsql-docs@lists.postgresql.org
Cc: johrss@amazon.com
Subject: Usage instructions for pg_hba.conf file
Date: Tue, 02 Aug 2022 20:08:07 +0000
Message-ID: <165947088723.651.7641196693246068619@wrigleys.postgresql.org> (raw)

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/14/auth-pg-hba-conf.html
Description:

On the pg_hba.conf page,
https://www.postgresql.org/docs/current/auth-pg-hba-conf.html, the bulk of
the page involves the format of the file and what the fields mean. There are
a couple of sentences of usage information (how to reload the file after
changes) in the middle of the reference info. It's possible to overlook the
how-to info on the long page if you don't need the details about the file
contents, just that one tip about reloading.

> The pg_hba.conf file is read on start-up and when the main server process
receives a SIGHUP signal. If you edit the file on an active system, you will
need to signal the postmaster (using pg_ctl reload, calling the SQL function
pg_reload_conf(), or using kill -HUP) to make it re-read the file.

I suggest moving the usage info to one end of the page or the other, and
adding a subheading to clarify that the page covers more than the syntax of
the file contents.  Possibilities:

21.1. The pg_hba.conf File
  Client authentication is controlled... (same first paragraph as before)

21.1.1 Loading or Reloading the Configuration
  The pg_hba.conf file is read on start-up...
  Note: The preceding statement...
  The system view pg_hba_file_rules can be helpful...

21.1.2 Contents of pg_hba.conf
  The general format of the pg_hba.conf file is a set of records...
  <all the other info about the format and contents of the file>

Example 21.1. Example pg_hba.conf Entries

or

21.1. The pg_hba.conf File
  Client authentication is controlled...
  The general format of the pg_hba.conf file is a set of records...
  <all the other info about the format and contents of the file>

Example 21.1. Example pg_hba.conf Entries

21.1.1 Loading or Reloading the Configuration
  The pg_hba.conf file is read on start-up...
  Note: The preceding statement...
  The system view pg_hba_file_rules can be helpful...

Thanks,
John


view thread (3+ messages)  latest in thread

Message-ID: <165947088723.651.7641196693246068619@wrigleys.postgresql.org>
Permalink:  ../165947088723.651.7641196693246068619@wrigleys.postgresql.org/
Also on:    postgresql.org/message-id/165947088723.651.7641196693246068619@wrigleys.postgresql.org

 · 

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: pgsql-docs@postgresql.org
  Cc: noreply@postgresql.org, pgsql-docs@lists.postgresql.org, johrss@amazon.com
  Subject: Re: Usage instructions for pg_hba.conf file
  In-Reply-To: <165947088723.651.7641196693246068619@wrigleys.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox