From 381d19b3ea0e7593d30a3af8df20d92bbccb775f Mon Sep 17 00:00:00 2001 From: Nathan Bossart Date: Tue, 23 May 2023 19:34:09 -0700 Subject: [PATCH] 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 --- doc/src/sgml/ref/createuser.sgml | 1 + src/bin/scripts/createuser.c | 4 ++-- src/bin/scripts/t/040_createuser.pl | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index ba7ed1f8531..5c34c623423 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -150,6 +150,7 @@ PostgreSQL documentation + (deprecated) 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 2d5e2452f78..0709491185c 100644 --- 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 40452fcae3b..9ca282181d8 100644 --- 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;/,