Thread: pg_hba.conf documentation

pg_hba.conf documentation

From
Peter Eisentraut
Date:
Does anyone else feel that the pg_hba.conf inline documentation is getting
too long?  The default file is now 259 lines.  I feel we should try to cut
this down to about 30-50 lines that have a reminder function, not a
complete specification.

-- 
Peter Eisentraut   peter_e@gmx.net



Re: pg_hba.conf documentation

From
Bruno Wolff III
Date:
On Sat, Sep 07, 2002 at 18:16:38 +0200, Peter Eisentraut <peter_e@gmx.net> wrote:
> Does anyone else feel that the pg_hba.conf inline documentation is getting
> too long?  The default file is now 259 lines.  I feel we should try to cut
> this down to about 30-50 lines that have a reminder function, not a
> complete specification.

Yes. The documentation in the config file should be available in the normal
documentation and hence only used to prompt an admin's memory, not provide
a detailed spec. Unless this documentation is built automatically it is
just two copies of the same data that have to be separately maintained.
However, it isn't a big deal for an admin to delete the comments if they
want.


Re: pg_hba.conf documentation

From
Bruce Momjian
Date:
Bruno Wolff III wrote:
> On Sat, Sep 07, 2002 at 18:16:38 +0200,
>   Peter Eisentraut <peter_e@gmx.net> wrote:
> > Does anyone else feel that the pg_hba.conf inline documentation is getting
> > too long?  The default file is now 259 lines.  I feel we should try to cut
> > this down to about 30-50 lines that have a reminder function, not a
> > complete specification.
> 
> Yes. The documentation in the config file should be available in the normal
> documentation and hence only used to prompt an admin's memory, not provide
> a detailed spec. Unless this documentation is built automatically it is
> just two copies of the same data that have to be separately maintained.
> However, it isn't a big deal for an admin to delete the comments if they
> want.

Yes, it is probably time to pull that stuff out of there and get it into
SGML.

--  Bruce Momjian                        |  http://candle.pha.pa.us pgman@candle.pha.pa.us               |  (610)
359-1001+  If your life is a hard drive,     |  13 Roberts Road +  Christ can be your backup.        |  Newtown Square,
Pennsylvania19073