Doc: improve documentation of pg_signal_backend default role.

tglsfdc · tglsfdc · commit e872432d629d · 2019-08-27T18:03:09.000-04:00
Give it an explanatory para like the other default roles have. Don't imply that it can send any signal whatever. In passing, reorder the table entries and explanatory paras for the default roles into some semblance of consistency. Ian Barwick, tweaked a bit by me. Discussion: https://postgr.es/m/89907e32-76f3-7282-a89c-ea19c722fe5d@2ndquadrant.com
diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml
@@ -530,17 +530,17 @@ DROP ROLE doomed_role;
        <entry>Execute monitoring functions that may take <literal>ACCESS SHARE</literal> locks on tables,
        potentially for a long time.</entry>
       </row>
-      <row>
-       <entry>pg_signal_backend</entry>
-       <entry>Send signals to other backends (eg: cancel query, terminate).</entry>
-      </row>
       <row>
        <entry>pg_monitor</entry>
        <entry>Read/execute various monitoring views and functions.
        This role is a member of <literal>pg_read_all_settings</literal>,
        <literal>pg_read_all_stats</literal> and
        <literal>pg_stat_scan_tables</literal>.</entry>
       </row>
+      <row>
+       <entry>pg_signal_backend</entry>
+       <entry>Signal another backend to cancel a query or terminate its session.</entry>
+      </row>
      </tbody>
     </tgroup>
    </table>
@@ -554,14 +554,23 @@ DROP ROLE doomed_role;
   other system information normally restricted to superusers.
   </para>
 
+  <para>
+  The <literal>pg_signal_backend</literal> role is intended to allow
+  administrators to enable trusted, but non-superuser, roles to send signals
+  to other backends. Currently this role enables sending of signals for
+  canceling a query on another backend or terminating its session. A user
+  granted this role cannot however send signals to a backend owned by a
+  superuser.  See <xref linkend="functions-admin-signal">.
+  </para>
+
   <para>
   Care should be taken when granting these roles to ensure they are only used where
   needed to perform the desired monitoring.
   </para>
 
   <para>
-   Administrators can grant access to these roles to users using the GRANT
-   command:
+   Administrators can grant access to these roles to users using the
+   <xref linkend="sql-grant"> command, for example:
 
 <programlisting>
 GRANT pg_signal_backend TO admin_user;
