aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorFredrik Gustafsson <[email protected]>2013-02-11 12:21:50 +0100
committerFredrik Gustafsson <[email protected]>2013-02-11 12:21:50 +0100
commit6b0aa99142ab7dcbc3db50b4940d6096d64ab6ef (patch)
treee0a35828601078cd489625c7664138d1e73f3c29 /lib/kernel/doc
parent8abbf2b7e348674930a31c34a08fa1424bc08c78 (diff)
parent0660708dd41e5b0b1c2d03487121ace9c3616374 (diff)
downloadotp-6b0aa99142ab7dcbc3db50b4940d6096d64ab6ef.tar.gz
otp-6b0aa99142ab7dcbc3db50b4940d6096d64ab6ef.tar.bz2
otp-6b0aa99142ab7dcbc3db50b4940d6096d64ab6ef.zip
Merge branch 'vd/code_get_mode/OTP-10823'
* vd/code_get_mode/OTP-10823: Added name prefix to code.xml Add a new function code:get_mode() can be used to detect how the code servers behaves
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/code.xml13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml
index 279c7558bc..dbcf376487 100644
--- a/lib/kernel/doc/src/code.xml
+++ b/lib/kernel/doc/src/code.xml
@@ -738,6 +738,19 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]),
<c>undefined</c>.</p>
</desc>
</func>
+
+ <func>
+ <name name="get_mode" arity="0"/>
+ <fsummary>The code_server's mode.</fsummary>
+ <desc>
+ <p>This function returns an atom describing the code_server's mode:
+ <c>interactive</c> or <c>embedded</c>. </p>
+ <p>This information is useful when an external entity (for example,
+ an IDE) provides additional code for a running node. If in interactive
+ mode, it only needs to add to the code path. If in embedded mode,
+ the code has to be loaded with <c>load_binary/3</c></p>
+ </desc>
+ </func>
</funcs>
</erlref>