diff options
| author | Lukas Larsson <lukas@erlang.org> | 2021-04-13 09:51:07 +0200 |
|---|---|---|
| committer | juhlig <juhlig@hnc-agency.org> | 2021-04-14 16:09:47 +0200 |
| commit | bf422e6ebb5b79527b5a18d94303087e6a0e304c (patch) | |
| tree | 48534ac4c3f52647f4869ba7b4d373047c256890 /lib | |
| parent | 39e3e5a5ad81d244ff6b9dc45ac743efb4331cc2 (diff) | |
| download | erlang-bf422e6ebb5b79527b5a18d94303087e6a0e304c.tar.gz | |
Add more sections to supervisor introduction
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/stdlib/doc/src/supervisor.xml | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index 3715c5e7d2..f3f404a600 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -69,6 +69,8 @@ this list. When the supervisor terminates, it first terminates its child processes in reversed start order, from right to left.</p> + <section> + <title>Supervisor flags</title> <marker id="sup_flags"/> <p>The supervisor properties are defined by the supervisor flags. The type definition for the supervisor flags is as follows:</p> @@ -79,6 +81,8 @@ sup_flags() = #{strategy => strategy(), % optional period => pos_integer(), % optional auto_shutdown => auto_shutdown()} % optional</pre> + <section> + <title>Restart Stratagies</title> <p>A supervisor can have one of the following <em>restart strategies</em> specified with the <c>strategy</c> key in the above map:</p> @@ -125,7 +129,9 @@ sup_flags() = #{strategy => strategy(), % optional defined.</p> </item> </list> - + </section> + <section> + <title>Restart intensity and period</title> <p>To prevent a supervisor from getting into an infinite loop of child process terminations and restarts, a <em>maximum restart intensity</em> is defined using two integer values specified @@ -137,7 +143,9 @@ sup_flags() = #{strategy => strategy(), % optional 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> - + </section> + <section> + <title>Automatic Shutdown</title> <marker id="auto_shutdown"/> <p>A supervisor can be configured to automatically shut itself down when <seeerl marker="#significant_child">significant children</seeerl> @@ -178,7 +186,10 @@ sup_flags() = #{strategy => strategy(), % optional expect that their applications may be compiled with older OTP versions.</p> </warning> - + </section> + </section> + <section> + <title>Child specification</title> <marker id="child_spec"/> <p>The type definition of a child specification is as follows:</p> @@ -323,6 +334,7 @@ child_spec() = #{id => child_id(), % mandatory </item> </list> </section> + </section> <datatypes> <datatype> |