diff options
| author | Xavier Noria <[email protected]> | 2018-01-23 11:47:58 +0100 |
|---|---|---|
| committer | Xavier Noria <[email protected]> | 2018-02-02 09:02:08 +0100 |
| commit | 2ab931cec15917e1297aafce350439c8daa7a726 (patch) | |
| tree | f1e5c320a329612633cb971056269d1b0d7ee1a7 /lib/kernel | |
| parent | 18d9afbd5c62bb7b7237fe0d580fc05737a096c1 (diff) | |
| download | otp-2ab931cec15917e1297aafce350439c8daa7a726.tar.gz otp-2ab931cec15917e1297aafce350439c8daa7a726.tar.bz2 otp-2ab931cec15917e1297aafce350439c8daa7a726.zip | |
Reword docs related to the runtime system mode
The existing wording may be interpreted as saying that embedded mode
eager loads all modules. This revision makes clear embedded mode only
disables module auto loading.
Since I was on it, I have reordered a couple of places to describe
interactive first, and then embedded. It feels natural to cover first
the default and positive mode (auto loads), and then its negation.
Diffstat (limited to 'lib/kernel')
| -rw-r--r-- | lib/kernel/doc/src/code.xml | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index c94f612c01..bd95819636 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -34,26 +34,28 @@ <p>This module contains the interface to the Erlang <em>code server</em>, which deals with the loading of compiled code into a running Erlang runtime system.</p> - <p>The runtime system can be started in <em>embedded</em> or - <em>interactive</em> mode. Which one is decided by command-line + <p>The runtime system can be started in <em>interactive</em> or + <em>embedded</em> mode. Which one is decided by the command-line flag <c>-mode</c>:</p> <pre> % <input>erl -mode interactive</input></pre> <p>The modes are as follows:</p> <list type="bulleted"> <item> - <p>In embedded mode, all code is loaded during system startup - according to the boot script. (Code can also be loaded later - by explicitly ordering the code server to do so).</p> - </item> - <item> <p>In interactive mode, which is default, only some code is loaded - during system startup, basically the modules needed by the runtime + during system startup, basically the modules needed by the runtime system. Other code is dynamically loaded when first referenced. When a call to a function in a certain module is made, and the module is not loaded, the code server searches for and tries to load the module.</p> </item> + <item> + <p>In embedded mode, modules are not auto loaded. Trying to use + a module that has not been loaded results in an error. This mode is + recommended when the boot script loads all modules, as it is + typically done in OTP releases. (Code can still be loaded later + by explicitly ordering the code server to do so).</p> + </item> </list> <p>To prevent accidentally reloading of modules affecting the Erlang runtime system, directories <c>kernel</c>, <c>stdlib</c>, |