Document deprecated createuser option.

2dcd1578c4 left the --role option undocumented, which is
inconsistent with other deprecated options such as pg_dump's
--blobs and --no-blobs.  This change adds --role back to
createuser's documentation and usage output and marks it as
deprecated.

Suggested-by: Peter Eisentraut
Reviewed-by: Michael Paquier
Discussion: https://postgr.es/m/0e85c9e7-4804-1cdb-5a4a-c72c328f9ad8%40enterprisedb.com

diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml
index ba7ed1f853157542fc2827bea6f6e80780bd1c5d..5c34c6234233b098e2727f399a384a6a6a3a796d 100644 (file)
--- a/doc/src/sgml/ref/createuser.sgml
+++ b/doc/src/sgml/ref/createuser.sgml
@@ -150,6 +150,7 @@ PostgreSQL documentation
      <varlistentry>
       <term><option>-g <replaceable class="parameter">role</replaceable></option></term>
       <term><option>--member-of=<replaceable class="parameter">role</replaceable></option></term>
+      <term><option>--role=<replaceable class="parameter">role</replaceable></option> (deprecated)</term>
       <listitem>
        <para>
         Specifies the new role should be automatically added as a member

diff --git a/src/bin/scripts/createuser.c b/src/bin/scripts/createuser.c
index 2d5e2452f782ce8bdd0e5a124f2e352fcf2fd4de..0709491185c39eb6d7e474ee7e7c39134ace62fe 100644 (file)
--- a/src/bin/scripts/createuser.c
+++ b/src/bin/scripts/createuser.c
@@ -34,8 +34,7 @@ main(int argc, char *argv[])
        {"no-createdb", no_argument, NULL, 'D'},
        {"echo", no_argument, NULL, 'e'},
        {"encrypted", no_argument, NULL, 'E'},
-       {"role", required_argument, NULL, 'g'}, /* kept for backward
-                                                * compatibility */
+       {"role", required_argument, NULL, 'g'},
        {"member-of", required_argument, NULL, 'g'},
        {"host", required_argument, NULL, 'h'},
        {"inherit", no_argument, NULL, 'i'},
@@ -423,6 +422,7 @@ help(const char *progname)
    printf(_("  -D, --no-createdb         role cannot create databases (default)\n"));
    printf(_("  -e, --echo                show the commands being sent to the server\n"));
    printf(_("  -g, --member-of=ROLE      new role will be a member of ROLE\n"));
+   printf(_("  --role=ROLE               (same as --member-of, deprecated)\n"));
    printf(_("  -i, --inherit             role inherits privileges of roles it is a\n"
             "                            member of (default)\n"));
    printf(_("  -I, --no-inherit          role does not inherit privileges\n"));

diff --git a/src/bin/scripts/t/040_createuser.pl b/src/bin/scripts/t/040_createuser.pl
index 40452fcae3bf1c151f8d58e8e641a77f53922171..9ca282181d8c882e14bea852c4da00f905f45aba 100644 (file)
--- a/src/bin/scripts/t/040_createuser.pl
+++ b/src/bin/scripts/t/040_createuser.pl
@@ -71,7 +71,7 @@ $node->issues_sql_like(
 $node->issues_sql_like(
    [ 'createuser', '--role', 'regress_user1', 'regress_user11' ],
    qr/statement: CREATE ROLE regress_user11 NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN NOREPLICATION NOBYPASSRLS IN ROLE regress_user1;/,
-   '--role (for backward compatibility)');
+   '--role');
 $node->issues_sql_like(
    [ 'createuser', '--member-of', 'regress_user1', 'regress_user12' ],
    qr/statement: CREATE ROLE regress_user12 NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN NOREPLICATION NOBYPASSRLS IN ROLE regress_user1;/,