aboutsummaryrefslogtreecommitdiffstats
path: root/system/doc/reference_manual
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2014-05-20 20:42:29 +0200
committerSverker Eriksson <[email protected]>2014-05-20 20:42:33 +0200
commitd4d5b4375dae706edb6deda9faebc66000aa2019 (patch)
tree8bacb40163179f93af6e3a5a23563f89d4882078 /system/doc/reference_manual
parent23f73961cbd2d48b019214dcba243afb80034ce9 (diff)
parent0dbcbea0cf52672ef1cf051c3cd7640eb7ff728e (diff)
downloadotp-d4d5b4375dae706edb6deda9faebc66000aa2019.tar.gz
otp-d4d5b4375dae706edb6deda9faebc66000aa2019.tar.bz2
otp-d4d5b4375dae706edb6deda9faebc66000aa2019.zip
Merge branch 'sverk/better-module-info'
OTP-11940 * sverk/better-module-info: Remove obsolete 'imports' entry from module_info/1/2 functions Add 'module' entry for module_info/0 function for completeness Add 'md5' entry for module_info/0/1 functions.
Diffstat (limited to 'system/doc/reference_manual')
-rw-r--r--system/doc/reference_manual/modules.xml18
1 files changed, 9 insertions, 9 deletions
diff --git a/system/doc/reference_manual/modules.xml b/system/doc/reference_manual/modules.xml
index f0ec7ef165..5fc8b363f8 100644
--- a/system/doc/reference_manual/modules.xml
+++ b/system/doc/reference_manual/modules.xml
@@ -229,13 +229,9 @@ behaviour_info(callbacks) -> Callbacks.</pre>
<p>The <c>module_info/0</c> function in each module returns
a list of <c>{Key,Value}</c> tuples with information about
the module. Currently, the list contain tuples with the following
- <c>Key</c>s: <c>attributes</c>, <c>compile</c>,
- <c>exports</c>, and <c>imports</c>. The order and number of tuples
+ <c>Key</c>s: <c>module</c>, <c>attributes</c>, <c>compile</c>,
+ <c>exports</c> and <c>md5</c>. The order and number of tuples
may change without prior notice.</p>
-
- <warning><p>The <c>{imports,Value}</c> tuple may be removed in a future
- release because <c>Value</c> is always an empty list.
- Do not write code that depends on it being present.</p></warning>
</section>
<section>
@@ -246,6 +242,11 @@ behaviour_info(callbacks) -> Callbacks.</pre>
<p>The following values are allowed for <c>Key</c>:</p>
<taglist>
+ <tag><c>module</c></tag>
+ <item>
+ <p>Return an atom representing the module name.</p>
+ </item>
+
<tag><c>attributes</c></tag>
<item>
<p>Return a list of <c>{AttributeName,ValueList}</c> tuples,
@@ -267,10 +268,9 @@ behaviour_info(callbacks) -> Callbacks.</pre>
<seealso marker="stdlib:beam_lib#strip/1">beam_lib(3)</seealso>.</p>
</item>
- <tag><c>imports</c></tag>
+ <tag><c>md5</c></tag>
<item>
- <p>Always return an empty list. The <c>imports</c> key may not
- be supported in future release.</p>
+ <p>Return a binary representing the MD5 checksum of the module.</p>
</item>
<tag><c>exports</c></tag>