doc: clarify "pg_signal_backend" default role
Hi
Currently the documentation for the default role "pg_signal_backend" states,
somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
giving the impression other signals (e.g. SIGHUP) can be sent too, which is
currently not the case.
Attached patch clarifies this, adds a descriptive paragraph (similar to what
the other default roles have) and a link to the "Server Signaling Functions"
section.
Patch applies cleanly to HEAD and REL_11_STABLE.
Regards
Ian Barwick
--
Ian Barwick https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services
Attachments:
doc-pg_signal_backend.patchtext/x-patch; name=doc-pg_signal_backend.patchDownload+9-2
On Mon, Jun 10, 2019 at 11:06:54AM +0900, Ian Barwick wrote:
Currently the documentation for the default role "pg_signal_backend" states,
somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
giving the impression other signals (e.g. SIGHUP) can be sent too, which is
currently not the case.
(Perhaps you should avoid cross-posting?)
OK, I can see your point.
Attached patch clarifies this, adds a descriptive paragraph (similar to what
the other default roles have) and a link to the "Server Signaling Functions"
section.
+1 for being more descriptive here.
--
Michael
Ian Barwick <ian.barwick@2ndquadrant.com> writes:
Currently the documentation for the default role "pg_signal_backend" states,
somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
giving the impression other signals (e.g. SIGHUP) can be sent too, which is
currently not the case.
Attached patch clarifies this, adds a descriptive paragraph (similar to what
the other default roles have) and a link to the "Server Signaling Functions"
section.
Pushed with minor tweaking.
(Note: patches are less likely to fall through the cracks if you
add them to the commitfest page.)
regards, tom lane
On 8/28/19 7:04 AM, Tom Lane wrote:
Ian Barwick <ian.barwick@2ndquadrant.com> writes:
Currently the documentation for the default role "pg_signal_backend" states,
somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
giving the impression other signals (e.g. SIGHUP) can be sent too, which is
currently not the case.
Attached patch clarifies this, adds a descriptive paragraph (similar to what
the other default roles have) and a link to the "Server Signaling Functions"
section.Pushed with minor tweaking.
Thanks!
(Note: patches are less likely to fall through the cracks if you
add them to the commitfest page.)
Yup, though I was intending to add that one together with a couple of
related minor doc patches to the next CF.
Regards
Ian Barwick
--
Ian Barwick https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services