diff options
| author | Björn Gustavsson <bjorn@erlang.org> | 2011-11-11 16:57:10 +0100 |
|---|---|---|
| committer | Björn Gustavsson <bjorn@erlang.org> | 2011-11-24 15:46:16 +0100 |
| commit | 9ac7e19e35b02c02e15abd3abc4e7b5c8b62752d (patch) | |
| tree | f5e04d508e88a82650810abcaf18819b08909edb /lib/stdlib/doc | |
| parent | f939cf61d13fe2d753f4c6ec7a47880db083a45f (diff) | |
| download | erlang-9ac7e19e35b02c02e15abd3abc4e7b5c8b62752d.tar.gz | |
filename documentation: Recommend against using filename:find_src/1,2
Diffstat (limited to 'lib/stdlib/doc')
| -rw-r--r-- | lib/stdlib/doc/src/filename.xml | 6 |
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 |