Re: Documentation Suggestion

On Fri, Apr 29, 2022 at 10:06:57AM -0400, Tom Lane wrote:
> 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?

I think the confusion is that while the option arguments are
case-sensitive, many of the values are typically used as all upper-case,
and I think any doc mention would have to include that:

Note that valid --auth option values are all lower case, even
for authentication types that typically appear as all upper case,
e.g., "LDAP".

--
Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
EDB https://enterprisedb.com

Indecision is a decision. Inaction is an action. Mark Batterson