aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2016-11-17 12:07:44 +0100
committerSiri Hansen <[email protected]>2016-11-17 12:07:44 +0100
commitb4f2e4d748390a83e2cdf6c48bd0a647fd1ac277 (patch)
tree557d7cbf3c4faf2d2f30c6986fc4a174be92a7bf
parentcf59b46a88582f3a4c486aff1c2eda6662b88eb2 (diff)
parent26b0619b05d36e87849ff249f0e68cf9bfd1d1fd (diff)
downloadotp-b4f2e4d748390a83e2cdf6c48bd0a647fd1ac277.tar.gz
otp-b4f2e4d748390a83e2cdf6c48bd0a647fd1ac277.tar.bz2
otp-b4f2e4d748390a83e2cdf6c48bd0a647fd1ac277.zip
Merge branch 'elbrujohalcon/expand-sup-doc/PR-1233/OTP-14037'
* elbrujohalcon/expand-sup-doc/PR-1233/OTP-14037: Expand on the behavior of supervisors
-rw-r--r--lib/stdlib/doc/src/supervisor.xml6
-rw-r--r--system/doc/design_principles/sup_princ.xml4
2 files changed, 7 insertions, 3 deletions
diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml
index 294196f746..bb06d3645e 100644
--- a/lib/stdlib/doc/src/supervisor.xml
+++ b/lib/stdlib/doc/src/supervisor.xml
@@ -133,8 +133,10 @@ sup_flags() = #{strategy => strategy(), % optional
map. Assuming the values <c>MaxR</c> for <c>intensity</c>
and <c>MaxT</c> for <c>period</c>, then, if more than <c>MaxR</c>
restarts occur within <c>MaxT</c> seconds, the supervisor
- terminates all child processes and then itself. <c>intensity</c>
- defaults to <c>1</c> and <c>period</c> defaults to <c>5</c>.</p>
+ terminates all child processes and then itself. The termination
+ reason for the supervisor itself in that case will be <c>shutdown</c>.
+ <c>intensity</c> defaults to <c>1</c> and <c>period</c> defaults to
+ <c>5</c>.</p>
<marker id="child_spec"/>
<p>The type definition of a child specification is as follows:</p>
diff --git a/system/doc/design_principles/sup_princ.xml b/system/doc/design_principles/sup_princ.xml
index 0a24e97950..c24177d842 100644
--- a/system/doc/design_principles/sup_princ.xml
+++ b/system/doc/design_principles/sup_princ.xml
@@ -163,7 +163,9 @@ SupFlags = #{strategy => Strategy, ...}</code>
SupFlags = #{intensity => MaxR, period => MaxT, ...}</code>
<p>If more than <c>MaxR</c> number of restarts occur in the last
<c>MaxT</c> seconds, the supervisor terminates all the child
- processes and then itself.</p>
+ processes and then itself.
+ The termination reason for the supervisor itself in that case will be
+ <c>shutdown</c>.</p>
<p>When the supervisor terminates, then the next higher-level
supervisor takes some action. It either restarts the terminated
supervisor or terminates itself.</p>