Re: Documentation Suggestion - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Documentation Suggestion
Date
Msg-id YozRQpzIo/v3Zr83@momjian.us
Whole thread Raw
In response to Re: Documentation Suggestion  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
Responses Re: Documentation Suggestion  (Bruce Momjian <bruce@momjian.us>)
List pgsql-docs
fOn Sat, May 14, 2022 at 05:21:58PM +0200, Álvaro Herrera wrote:
> I pushed the other suggested bits.
> 
> On 2022-May-13, Bruce Momjian wrote:
> 
> > On Fri, Apr 29, 2022 at 10:06:57AM -0400, Tom Lane wrote:
> 
> > > 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".
> 
> Yeah, that was my initial thought too.  The case-sensitivity is a
> consideration for other things too (such as locale or encoding names),
> but for those we do match the operating system name exactly, rather than
> using our own lower-case version of it, which nobody else uses.
> 
> So really the point is not about the fact that it is case sensitive as
> that the case of our name doesn't match the usual one.  Maybe the note
> should be "Note that authentication types are all lower case, [even for
> ...]" or something like that.

Agreed.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

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




pgsql-docs by date:

Previous
From: "yanliang lei"
Date:
Subject: about pg14 new parameter in_hot_standby
Next
From: Bruce Momjian
Date:
Subject: Re: about pg14 new parameter in_hot_standby