aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/supervisor.xml
diff options
context:
space:
mode:
authorZandra Hird <[email protected]>2015-05-29 14:34:27 +0200
committerZandra Hird <[email protected]>2015-05-29 14:34:27 +0200
commit5889686cb7252e9019b88492726a1237d3e8566d (patch)
tree649d3494b73686644bde8415504bd9d3d68f0a10 /lib/stdlib/doc/src/supervisor.xml
parent585a0448b8e04927b1516298a91568565fa00441 (diff)
parent000c33662b8a98870a97a3499076895d4e832563 (diff)
downloadotp-5889686cb7252e9019b88492726a1237d3e8566d.tar.gz
otp-5889686cb7252e9019b88492726a1237d3e8566d.tar.bz2
otp-5889686cb7252e9019b88492726a1237d3e8566d.zip
Merge branch 'fishcakez/supervisor_ignore'
* fishcakez/supervisor_ignore: Don't store child that returns ignore in simple supervisor OTP-12793
Diffstat (limited to 'lib/stdlib/doc/src/supervisor.xml')
-rw-r--r--lib/stdlib/doc/src/supervisor.xml12
1 files changed, 9 insertions, 3 deletions
diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml
index ffac1c0bd7..6ff477a42d 100644
--- a/lib/stdlib/doc/src/supervisor.xml
+++ b/lib/stdlib/doc/src/supervisor.xml
@@ -386,9 +386,15 @@
added to the supervisor and the function returns the same
value.</p>
<p>If the child process start function returns <c>ignore</c>,
- the child specification is added to the supervisor, the pid
- is set to <c>undefined</c>, and the function returns
- <c>{ok,undefined}</c>.</p>
+ the child specification is added to the supervisor (unless the
+ supervisor is a <c>simple_one_for_one</c> supervisor, see below),
+ the pid is set to <c>undefined</c> and the function returns
+ <c>{ok,undefined}</c>.
+ </p>
+ <p>In the case of a <c>simple_one_for_one</c> supervisor, when a child
+ process start function returns <c>ignore</c> the functions returns
+ <c>{ok,undefined}</c> and no child is added to the supervisor.
+ </p>
<p>If the child process start function returns an error tuple or
an erroneous value, or if it fails, the child specification is
discarded, and the function returns <c>{error,Error}</c> where