From: Bruce Momjian <bruce@momjian.us>
To: David G. Johnston <david.g.johnston@gmail.com>
Cc: mali_86@outlook.com, Pg Docs <pgsql-docs@lists.postgresql.org>
Subject: Re: psql's commit df9f599b is not documented
Date: Mon, 2 Aug 2021 20:03:50 -0400
Message-ID: <20210803000350.GA3639@momjian.us> (raw)
In-Reply-To: <CAKFQuwYS2H1Q6wwy33G+aERP5Y58kMeiZ0x9TpCx=qDN=KvROw@mail.gmail.com>
References: <162794046650.25749.16629649309696437240@wrigleys.postgresql.org>
<CAKFQuwYddkFFAojWojCLjKb8Uq-BEXfX3O6fCPYOAB4SLtn20A@mail.gmail.com>
<20210802230959.GA7858@momjian.us>
<CAKFQuwYS2H1Q6wwy33G+aERP5Y58kMeiZ0x9TpCx=qDN=KvROw@mail.gmail.com>
On Mon, Aug 2, 2021 at 04:27:01PM -0700, David G. Johnston wrote:
> On Mon, Aug 2, 2021 at 4:10 PM Bruce Momjian <bruce@momjian.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@postgresql.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").
I think we put it in the PG 11 release notes so people who used Postgres
previously would know this item is improved, but for new folks, it will
just work if they try it, but we don't want to encourage them to try it.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com
If only the physical world exists, free will is an illusion.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: bruce@momjian.us, david.g.johnston@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: psql's commit df9f599b is not documented
In-Reply-To: <20210803000350.GA3639@momjian.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox