aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2011-11-28 15:05:23 +0100
committerBjörn Gustavsson <[email protected]>2011-11-28 15:05:23 +0100
commitaa6824a16ba83c35ad35f9dde40c5a198c7002a2 (patch)
treecbd05ba751d4ea69f3b5caec2fdae0c9ba68265e /lib/stdlib/doc
parent5c3dbd080f27f683f2d30c9c7072547c68d715b3 (diff)
parent9ac7e19e35b02c02e15abd3abc4e7b5c8b62752d (diff)
downloadotp-aa6824a16ba83c35ad35f9dde40c5a198c7002a2.tar.gz
otp-aa6824a16ba83c35ad35f9dde40c5a198c7002a2.tar.bz2
otp-aa6824a16ba83c35ad35f9dde40c5a198c7002a2.zip
Merge branch 'bjorn/compiler/options/OTP-9752'
* bjorn/compiler/options/OTP-9752: filename documentation: Recommend against using filename:find_src/1,2 Teach filename:find_src/1,2 to handle slim or stripped BEAM files filename: Eliminate failing call to Mod:module_info(source_file) filename.erl:filter_options/1: Remove handling of dead options compiler: Don't include {cwd,_} in module_info(compile) compiler: Don't include source code options in module_info(compile) hipe: Teach hipe to handle slim or stripped BEAM files
Diffstat (limited to 'lib/stdlib/doc')
-rw-r--r--lib/stdlib/doc/src/filename.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/filename.xml b/lib/stdlib/doc/src/filename.xml
index bc3a616d39..9296319b83 100644
--- a/lib/stdlib/doc/src/filename.xml
+++ b/lib/stdlib/doc/src/filename.xml
@@ -295,6 +295,12 @@
<p>Finds the source filename and compiler options for a module.
The result can be fed to <c>compile:file/2</c> in order to
compile the file again.</p>
+
+ <warning><p>We don't recommend using this function. If possible,
+ use <seealso marker="beam_lib">beam_lib(3)</seealso> to extract
+ the abstract code format from the BEAM file and compile that
+ instead.</p></warning>
+
<p>The <c><anno>Beam</anno></c> argument, which can be a string or an atom,
specifies either the module name or the path to the source
code, with or without the <c>".erl"</c> extension. In either