From: Bruce Momjian <bruce@momjian.us>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: t.kitynski@gmail.com
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: Suggestion for deprecated spellings
Date: Wed, 27 Sep 2023 20:17:54 -0400
Message-ID: <ZRTGMpPpFCFbdSsM@momjian.us> (raw)
In-Reply-To: <Y9gz2rRpm6VKnC0M@momjian.us>
References: <167473556945.2667294.2003897901995802549@wrigleys.postgresql.org>
<Y9grBFU+2DBXBB7z@momjian.us>
<888259.1675112866@sss.pgh.pa.us>
<Y9gz2rRpm6VKnC0M@momjian.us>
On Mon, Jan 30, 2023 at 04:17:14PM -0500, Bruce Momjian wrote:
> On Mon, Jan 30, 2023 at 04:07:46PM -0500, Tom Lane wrote:
> > Bruce Momjian <bruce@momjian.us> writes:
> > > On Thu, Jan 26, 2023 at 12:19:29PM +0000, PG Doc comments form wrote:
> > >> From time to time some spelling for given command gets obsolete, yet it is
> > >> shown in the syntax on "equal rights" as other valid clauses.
> >
> > > We don't need to show all _supported_ syntaxes in the "Synopsis"
> > > section, so we could just remove them.
> >
> > IIRC, there is precedent in COPY for moving obsolete alternatives
> > to a separate part of the man page. I'd prefer that to just
> > removing them, because then there is no documentation to help
> > someone understand what an old SQL script is doing.
>
> Yeah, I remember that with COPY. t.kitynski@gmail.com, please us that
> as a guide. Thanks.
I developed the attached patch to move the deprecated clauses to the
bottom.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com
Only you can decide what is important to you.
Attachments:
[text/x-diff] group.diff (2.8K, ../ZRTGMpPpFCFbdSsM@momjian.us/2-group.diff)
download | inline diff:diff --git a/doc/src/sgml/ref/create_role.sgml b/doc/src/sgml/ref/create_role.sgmlindex 7249fc7432..6a3cd6d808 100644--- a/doc/src/sgml/ref/create_role.sgml+++ b/doc/src/sgml/ref/create_role.sgml@@ -36,10 +36,8 @@ CREATE ROLE <replaceable class="parameter">name</replaceable> [ [ WITH ] <replac
| [ ENCRYPTED ] PASSWORD '<replaceable class="parameter">password</replaceable>' | PASSWORD NULL
| VALID UNTIL '<replaceable class="parameter">timestamp</replaceable>'
| IN ROLE <replaceable class="parameter">role_name</replaceable> [, ...]
- | IN GROUP <replaceable class="parameter">role_name</replaceable> [, ...]
| ROLE <replaceable class="parameter">role_name</replaceable> [, ...]
| ADMIN <replaceable class="parameter">role_name</replaceable> [, ...]
- | USER <replaceable class="parameter">role_name</replaceable> [, ...]
| SYSID <replaceable class="parameter">uid</replaceable>
</synopsis>
</refsynopsisdiv>
@@ -294,15 +292,6 @@ in sync when changing the above synopsis!
</listitem>
</varlistentry>
- <varlistentry>- <term><literal>IN GROUP</literal> <replaceable class="parameter">role_name</replaceable></term>- <listitem>- <para><literal>IN GROUP</literal> is an obsolete spelling of- <literal>IN ROLE</literal>.- </para>- </listitem>- </varlistentry>-
<varlistentry>
<term><literal>ROLE</literal> <replaceable class="parameter">role_name</replaceable></term>
<listitem>
@@ -326,16 +315,6 @@ in sync when changing the above synopsis!
</listitem>
</varlistentry>
- <varlistentry>- <term><literal>USER</literal> <replaceable class="parameter">role_name</replaceable></term>- <listitem>- <para>- The <literal>USER</literal> clause is an obsolete spelling of- the <literal>ROLE</literal> clause.- </para>- </listitem>- </varlistentry>-
<varlistentry>
<term><literal>SYSID</literal> <replaceable class="parameter">uid</replaceable></term>
<listitem>
@@ -484,6 +463,22 @@ CREATE ROLE <replaceable class="parameter">name</replaceable> [ WITH ADMIN <repl
by giving users the <literal>NOINHERIT</literal> attribute, while roles are
given the <literal>INHERIT</literal> attribute.
</para>
++ <para>+ The <literal>USER</literal> clause has the same behavior as+ <literal>ROLE</literal> but has been deprecated:+<synopsis>+ USER <replaceable class="parameter">role_name</replaceable> [, ...]+</synopsis>+ </para>++ <para>+ The <literal>IN GROUP</literal> clause has the same behavior as <literal>IN+ ROLE</literal> but has been deprecated:+<synopsis>+ IN GROUP <replaceable class="parameter">role_name</replaceable> [, ...]+</synopsis>+ </para>
</refsect1>
<refsect1>
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, tgl@sss.pgh.pa.us, t.kitynski@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: Suggestion for deprecated spellings
In-Reply-To: <ZRTGMpPpFCFbdSsM@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