Re: Documentation Suggestion

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
Cc: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, jhebert(at)micron(dot)com, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Documentation Suggestion
Date: 2022-04-29 14:06:57
Message-ID: 317936.1651241217@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> writes:
> On 2022-Apr-28, David G. Johnston wrote:
>> But we don't go out of our way anywhere else to be so explicit about this
>> kind of requirement and don't see a point of making this instance an
>> exception.

> Maybe we could add a <para> in the Options section before the item list,
> along the lines of "be mindful that arguments to options --auth,
> --auth-local, --encoding, --locale (and all --lc-* options) are
> case-sensitive".

I don't think this is an improvement, mainly for the reason David
mentions: why wouldn't you need a similar statement on every single
one of our program man pages?

>> The page could use a hyperlink/cross-reference to the pg_hba.conf
>> documentation.

> That's easily fixed. How about the attached patch?

That part's OK, but personally I'd only have cited the link once.

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message David G. Johnston 2022-04-29 15:05:36 Re: Documentation Suggestion
Previous Message Peter Eisentraut 2022-04-29 09:52:45 Re: Documentation Suggestion