diff options
| author | Björn Gustavsson <[email protected]> | 2017-04-26 12:47:41 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2017-04-26 12:47:41 +0200 |
| commit | a46b05d3fd38c76824faf4eccba0f2117abd9bff (patch) | |
| tree | 3d88cdc035ca32434ecd92fcbac9ab20568d1318 /lib/compiler/doc/src | |
| parent | 9ded73921e8a6a5ecf00c27028fcff1bf1961992 (diff) | |
| parent | 9dfb4eda78ade372ff5055b618612e478dc900e6 (diff) | |
| download | otp-a46b05d3fd38c76824faf4eccba0f2117abd9bff.tar.gz otp-a46b05d3fd38c76824faf4eccba0f2117abd9bff.tar.bz2 otp-a46b05d3fd38c76824faf4eccba0f2117abd9bff.zip | |
Merge pull request #1367 from josevalim/jv-dbgi-chunk
Introduce new "Dbgi" chunk
OTP-14369
Diffstat (limited to 'lib/compiler/doc/src')
| -rw-r--r-- | lib/compiler/doc/src/compile.xml | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml index ed04dac1c0..94bda0d5e3 100644 --- a/lib/compiler/doc/src/compile.xml +++ b/lib/compiler/doc/src/compile.xml @@ -132,12 +132,10 @@ <tag><c>debug_info</c></tag> <item> <marker id="debug_info"></marker> - <p>Includes debug information in the form of abstract code - (see - <seealso marker="erts:absform">The Abstract Format</seealso> - in ERTS User's Guide) in the compiled beam module. Tools - such as Debugger, Xref, and Cover require - the debug information to be included.</p> + <p>Includes debug information in the form of <seealso marker="erts:absform"> + Erlang Abstract Format</seealso> in the <c>debug_info</c> + chunk of the compiled beam module. Tools such as Debugger, + Xref, and Cover require the debug information to be included.</p> <p><em>Warning</em>: Source code can be reconstructed from the debug information. Use encrypted debug information @@ -147,6 +145,21 @@ <seealso marker="stdlib:beam_lib#debug_info">beam_lib(3)</seealso>.</p> </item> + <tag><c>{debug_info, {Backend, Data}}</c></tag> + <item> + <marker id="debug_info"></marker> + <p>Includes custom debug information in the form of a + <c>Backend</c> module with custom <c>Data</c> in the compiled beam module. + The given module must implement a <c>debug_info/4</c> function + and is responsible for generating different code representations, + as described in the <c>debug_info</c> under + <seealso marker="stdlib:beam_lib#debug_info">beam_lib(3)</seealso>.</p> + + <p><em>Warning</em>: Source code can be reconstructed from + the debug information. Use encrypted debug information + (<c>encrypt_debug_info</c>) to prevent this.</p> + </item> + <tag><c>{debug_info_key,KeyString}</c></tag> <item></item> <tag><c>{debug_info_key,{Mode,KeyString}}</c></tag> |