aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Gudmundsson <[email protected]>2019-01-22 10:23:58 +0100
committerGitHub <[email protected]>2019-01-22 10:23:58 +0100
commitab62e9783c22898b95b89bc5bac8ba55e8aa3da1 (patch)
treeb6778ff1f83dc02e6963a869d30694fb1298352b
parent1a2feb858341f102b436027084e57d6857b2f6b1 (diff)
parent35f980b6fd5fa21181f307d49baf1e2ce01a2b7a (diff)
downloadotp-ab62e9783c22898b95b89bc5bac8ba55e8aa3da1.tar.gz
otp-ab62e9783c22898b95b89bc5bac8ba55e8aa3da1.tar.bz2
otp-ab62e9783c22898b95b89bc5bac8ba55e8aa3da1.zip
Merge pull request #2086 from disappearer/improve-mnesia-start-docs
Specify that mnesia:start/0 is async
-rw-r--r--lib/mnesia/doc/src/mnesia.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml
index 94f1af34bf..11b0b8e987 100644
--- a/lib/mnesia/doc/src/mnesia.xml
+++ b/lib/mnesia/doc/src/mnesia.xml
@@ -2077,6 +2077,13 @@ mnesia:create_table(employee,
<fsummary>Starts a local Mnesia system.</fsummary>
<desc>
<marker id="start"></marker>
+ <p>Mnesia startup is asynchronous. The function call
+ <c>mnesia:start()</c> returns the atom <c>ok</c> and then
+ starts to initialize the different tables. Depending on the
+ size of the database, this can take some time, and the
+ application programmer must wait for the tables that the
+ application needs before they can be used. This is achieved
+ by using the function <c>mnesia:wait_for_tables/2</c>.</p>
<p>The startup procedure for a set of Mnesia nodes is a
fairly complicated operation. A Mnesia system consists
of a set of nodes, with Mnesia started locally on all