correct documentation in set role

Started by PG Bug reporting formover 2 years ago3 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/sql-set-role.html
Description:

it is good to mention that:
The specified role_name must be a role that the current session user is a
member of "and has SET True option on it."
The second part missed in documentation for set role command.

#2Bruce Momjian
bruce@momjian.us
In reply to: PG Bug reporting form (#1)
Re: correct documentation in set role

On Mon, Sep 25, 2023 at 07:46:18AM +0000, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/sql-set-role.html
Description:

it is good to mention that:
The specified role_name must be a role that the current session user is a
member of "and has SET True option on it."
The second part missed in documentation for set role command.

Good point. How is the attached patch?

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

Only you can decide what is important to you.

Attachments:

set_role.difftext/x-diff; charset=us-asciiDownload+2-1
#3Bruce Momjian
bruce@momjian.us
In reply to: Bruce Momjian (#2)
Re: correct documentation in set role

On Tue, Sep 26, 2023 at 11:44:42AM -0400, Bruce Momjian wrote:

On Mon, Sep 25, 2023 at 07:46:18AM +0000, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/sql-set-role.html
Description:

it is good to mention that:
The specified role_name must be a role that the current session user is a
member of "and has SET True option on it."
The second part missed in documentation for set role command.

Good point. How is the attached patch?

diff --git a/doc/src/sgml/ref/set_role.sgml b/doc/src/sgml/ref/set_role.sgml
index 13bad1bf66..a2661945aa 100644
--- a/doc/src/sgml/ref/set_role.sgml
+++ b/doc/src/sgml/ref/set_role.sgml
@@ -42,7 +42,8 @@ RESET ROLE
<para>
The specified <replaceable class="parameter">role_name</replaceable>
-   must be a role that the current session user is a member of.
+   must be a role that the current session user is a member of and
+   is granted <literal>WITH SET TRUE</literal>.
(If the session user is a superuser, any role can be selected.)
</para>

Someone is already working on this text addition from a post yesterday:

/messages/by-id/20230925220945.GB3172533@nathanxps13

Please ignore my patch and I will be sure the patch at this URL gets
committed. Thanks.

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

Only you can decide what is important to you.