From fdb350a4c98f070c264b8bd4ea9eca2513352f21 Mon Sep 17 00:00:00 2001 From: Richard Carlsson <richardc@klarna.com> Date: Wed, 14 May 2014 14:46:46 +0200 Subject: Add 'md5' entry for module_info/0/1 functions. --- system/doc/reference_manual/modules.xml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'system') diff --git a/system/doc/reference_manual/modules.xml b/system/doc/reference_manual/modules.xml index f0ec7ef165..c8f443d9dd 100644 --- a/system/doc/reference_manual/modules.xml +++ b/system/doc/reference_manual/modules.xml @@ -230,7 +230,7 @@ behaviour_info(callbacks) -> Callbacks.</pre> 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>exports</c>, <c>imports</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 @@ -273,6 +273,11 @@ behaviour_info(callbacks) -> Callbacks.</pre> be supported in future release.</p> </item> + <tag><c>md5</c></tag> + <item> + <p>Return a binary representing the MD5 checksum of the module.</p> + </item> + <tag><c>exports</c></tag> <item> <p>Return a list of <c>{Name,Arity}</c> tuples with -- cgit v1.2.3 From 4ad572a8b66df8174d92157411326aab95ee8124 Mon Sep 17 00:00:00 2001 From: Richard Carlsson <richardc@klarna.com> Date: Wed, 14 May 2014 14:49:10 +0200 Subject: Add 'module' entry for module_info/0 function for completeness as it exist in module_info/1. --- system/doc/reference_manual/modules.xml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'system') diff --git a/system/doc/reference_manual/modules.xml b/system/doc/reference_manual/modules.xml index c8f443d9dd..ac778805fe 100644 --- a/system/doc/reference_manual/modules.xml +++ b/system/doc/reference_manual/modules.xml @@ -229,7 +229,7 @@ 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>Key</c>s: <c>module</c>, <c>attributes</c>, <c>compile</c>, <c>exports</c>, <c>imports</c> and <c>md5</c>. The order and number of tuples may change without prior notice.</p> @@ -246,6 +246,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, -- cgit v1.2.3 From 0dbcbea0cf52672ef1cf051c3cd7640eb7ff728e Mon Sep 17 00:00:00 2001 From: Richard Carlsson <richardc@klarna.com> Date: Wed, 14 May 2014 14:54:16 +0200 Subject: Remove obsolete 'imports' entry from module_info/1/2 functions It previously always returned an empty list and was documented to be removed. --- system/doc/reference_manual/modules.xml | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) (limited to 'system') diff --git a/system/doc/reference_manual/modules.xml b/system/doc/reference_manual/modules.xml index ac778805fe..5fc8b363f8 100644 --- a/system/doc/reference_manual/modules.xml +++ b/system/doc/reference_manual/modules.xml @@ -230,12 +230,8 @@ behaviour_info(callbacks) -> Callbacks.</pre> 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>module</c>, <c>attributes</c>, <c>compile</c>, - <c>exports</c>, <c>imports</c> and <c>md5</c>. The order and number of tuples + <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> @@ -272,12 +268,6 @@ behaviour_info(callbacks) -> Callbacks.</pre> <seealso marker="stdlib:beam_lib#strip/1">beam_lib(3)</seealso>.</p> </item> - <tag><c>imports</c></tag> - <item> - <p>Always return an empty list. The <c>imports</c> key may not - be supported in future release.</p> - </item> - <tag><c>md5</c></tag> <item> <p>Return a binary representing the MD5 checksum of the module.</p> -- cgit v1.2.3