Re: is_superuser is not documented

From: bt22kawamotok <bt22kawamotok(at)oss(dot)nttdata(dot)com>
To: Fujii Masao <masao(dot)fujii(at)oss(dot)nttdata(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Euler Taveira <euler(at)eulerto(dot)com>, pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: is_superuser is not documented
Date: 2022-09-13 08:25:26
Message-ID: b6bd1b9f0cfcc0382ebecefcb5a7cddf@oss.nttdata.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers


> Thanks for the patch!
>
>
> + <varlistentry id="guc-is-superuser" xreflabel="is_superuser">
> + <term><varname>is_superuser</varname> (<type>boolean</type>)
>
> You need to add this entry just after that of "in_hot_standby" because
> the descriptions of preset parameters should be placed in alphabetical
> order in the docs.
>
>
> + <para>
> + Reports whether the user is superuser or not.
>
> Isn't it better to add "current" before "user", e.g.,
> "Reports whether the current user is a superuser"?
>
>
> /* Not for general use --- used by SET SESSION AUTHORIZATION */
> - {"is_superuser", PGC_INTERNAL, UNGROUPED,
> + {"is_superuser", PGC_INTERNAL, PRESET_OPTIONS,
>
> This comment should be rewritten or removed because "Not for general
> use" part is not true.
>
>
> - GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL |
> GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
> + GUC_REPORT | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE |
> GUC_DISALLOW_IN_FILE
>
> As Tom commented upthread, GUC_NO_RESET_ALL flag should be removed
> because it's not necessary when PGC_INTERNAL context (i.e., in this
> context,
> RESET ALL is prohibit by defaulted) is used.
>
>
> With the patch, make check failed. You need to update
> src/test/regress/expected/guc.out.
>
>
> <varlistentry>
> <term><literal>IS_SUPERUSER</literal></term>
> <listitem>
> <para>
> True if the current role has superuser privileges.
> </para>
>
> I found that the docs of SET command has the above description about
> is_superuser.
> This description seems useless if we document the is_superuser GUC
> itself. So isn't
> it better to remove this description?

Thank you for your review.
I create new patch add_document_is_superuser_v2.
please check it.

Regards,
Kotaro Kawamoto

Attachment Content-Type Size
add_document_is_superuser_v2.patch text/x-diff 2.4 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2022-09-13 08:27:03 Re: Transparent column encryption
Previous Message Laurenz Albe 2022-09-13 08:06:03 Tuples inserted and deleted by the same transaction