Re: psql's commit df9f599b is not documented

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: mali_86(at)outlook(dot)com, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: psql's commit df9f599b is not documented
Date: 2021-08-02 23:27:01
Message-ID: CAKFQuwYS2H1Q6wwy33G+aERP5Y58kMeiZ0x9TpCx=qDN=KvROw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, Aug 2, 2021 at 4:10 PM Bruce Momjian <bruce(at)momjian(dot)us> wrote:

> On Mon, Aug 2, 2021 at 03:31:15PM -0700, David G. Johnston wrote:
> > On Mon, Aug 2, 2021 at 2:58 PM PG Doc comments form <
> noreply(at)postgresql(dot)org>
> > wrote:
> >
> > quit and exit commands have been added to psql starting from psql 11
> > through
> > this commit df9f599b
> > https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=
> > df9f599bc6f14307252ac75ea1dc997310da5ba6
> > but it is not documented in psql documentation
> >
> >
> > All documented commands begin with a backslash - and indeed \help and
> \quit are
> > the official ways to get help and to quit psql. While the others exist
> as a
> > courtesy they are "unofficial" and thus we've chosen to not document
> them.
>
> FYI, this was mentioned in the PG 11 release notes:
>
>
Yes, the OP pointed that out. It seems inconsistent...either we should
document the addition both in the release notes and the psql page proper,
or neither. Documenting it only in the release notes seems like the worst
possible combination (forgetting the release notes and adding it to the
documentation proper at least makes it "official").

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Anthony Berglas 2021-08-02 23:29:38 Re: Common case not at all clear
Previous Message Bruce Momjian 2021-08-02 23:09:59 Re: psql's commit df9f599b is not documented