File 0625-Accurate-documentation-for-application-ens... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0625-Accurate-documentation-for-application-ensure_all_st.patch of Package erlang (Revision 20341d3ca8beab07b502d76ce8eb2b1a)

Currently displaying revision 20341d3ca8beab07b502d76ce8eb2b1a , Show latest

From 23ca8b4f9bfc7dff006b92c71eedcb9c0861e542 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A5rten=20Nilsson?= <marten.nilsson@klarna.com>
Date: Thu, 27 Aug 2020 14:58:03 +0200
Subject: [PATCH] Accurate documentation for application:ensure_all_started

Before this change, the documentation incorecctly describes the
case of running application:ensure_all_started for an application
which is started, but has unstarted dependencies.
---
 lib/kernel/doc/src/application.xml | 35 ++++++++++++++++--------------
 1 file changed, 19 insertions(+), 16 deletions(-)

diff --git a/lib/kernel/doc/src/application.xml b/lib/kernel/doc/src/application.xml
index 7aacfcba01..81d97c41bc 100644
--- a/lib/kernel/doc/src/application.xml
+++ b/lib/kernel/doc/src/application.xml
@@ -68,22 +68,25 @@
 </datatypes>
 <funcs>
 <func>
- <name name="ensure_all_started" arity="1"/>
- <name name="ensure_all_started" arity="2"/>
- <fsummary>Load and start an application and its dependencies, recursively.</fsummary>
- <desc>
- Equivalent to calling
-	 <seealso marker="#start/1"><c>start/1,2</c></seealso>
- repeatedly on all dependencies that are not yet started for an application.
- 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).
-	 The function reports <c>{error, {AppName,Reason}}</c> for errors, where
-	 <c>Reason</c> is any possible reason returned by
-	 <seealso marker="#start/1"><c>start/1,2</c></seealso>
-	 when starting a specific dependency.
-	 If an error occurs, the applications started by the function are stopped
-	 to bring the set of running applications back to its initial state.
- </desc>
+ <name name="ensure_all_started" arity="1"/>
+ <name name="ensure_all_started" arity="2"/>
+ <fsummary>Load and start an application and its dependencies, recursively.</fsummary>
+ <desc>
+ Equivalent to calling
+ <seealso marker="#start/1"><c>start/1,2</c></seealso>
+ repeatedly on all dependencies that are not yet started for an
+ application that is not yet started.
+ Returns <c>{ok, AppNames}</c>, where <c>AppNames</c> is a list of the application names
+ that was actually started by this call.
+ The list might be empty, or not contain all dependencies if the application
+ or some of its dependencies are already started.
+ The function reports <c>{error, {AppName,Reason}}</c> for errors, where
+ <c>Reason</c> is any possible reason returned by
+ <seealso marker="#start/1"><c>start/1,2</c></seealso>
+ when starting a specific dependency.
+ If an error occurs, the applications started by the function are stopped
+ to bring the set of running applications back to its initial state.
+ </desc>
 </func>
 <func>
 <name name="ensure_started" arity="1"/>
-- 
2.26.2

Places

File 0625-Accurate-documentation-for-application-ensure_all_st.patch of Package erlang (Revision 20341d3ca8beab07b502d76ce8eb2b1a)

Places