diff options
Diffstat (limited to 'lib/kernel/doc/src/application.xml')
| -rw-r--r-- | lib/kernel/doc/src/application.xml | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/lib/kernel/doc/src/application.xml b/lib/kernel/doc/src/application.xml index 2a807e62bb..a1f585f5cd 100644 --- a/lib/kernel/doc/src/application.xml +++ b/lib/kernel/doc/src/application.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>1996</year><year>2021</year> + <year>1996</year><year>2023</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -69,12 +69,21 @@ <func> <name name="ensure_all_started" arity="1" since="OTP R16B02"/> <name name="ensure_all_started" arity="2" since="OTP R16B02"/> - <fsummary>Load and start an application and its dependencies, recursively.</fsummary> + <name name="ensure_all_started" arity="3" since="OTP @OTP-18451@"/> + <fsummary>Loads and starts all applications and their dependencies, recursively.</fsummary> <desc> - <p>Equivalent to calling + <p><c><anno>Applications</anno></c> is either an an <c>atom()</c> or a list + of <c>atom()</c> representing multiple applications.</p> + <p>This function is equivalent to calling <seemfa marker="#start/1"><c>start/1,2</c></seemfa> - repeatedly on all dependencies that are not yet started for an application. + repeatedly on all dependencies that are not yet started of each application. Optional dependencies will also be loaded and started if they are available.</p> + <p>The <c><anno>Mode</anno></c> argument controls if the applications should + be started in <c>serial</c> mode (one at a time) or <c>concurrent</c> mode. + In concurrent mode, a dependency graph is built and the leaves of the graph + are started concurrently and recursively. In both modes, no assertion can be + made about the order the applications are started. If not supplied, it defaults + to <c>serial</c>.</p> <p>Returns <c>{ok, AppNames}</c> for a successful start or for an already started application (which is, however, omitted from the <c>AppNames</c> list).</p> <p>The function reports <c>{error, {AppName,Reason}}</c> for errors, where @@ -181,6 +190,16 @@ </desc> </func> <func> + <name name="get_supervisor" arity="1" since="OTP @OTP-18444@"/> + <fsummary>Get the supervisor of an application.</fsummary> + <desc> + <p>Returns the <c><anno>Pid</anno></c> of the supervisor running + at the root of <c><anno>Application</anno></c>.</p> + <p>If the specified application does not exist or does not + define a callback module, the function returns <c>undefined</c>.</p> + </desc> + </func> + <func> <name name="load" arity="1" since=""/> <name name="load" arity="2" since=""/> <fsummary>Load an application.</fsummary> |