aboutsummaryrefslogtreecommitdiffstats
path: root/lib/compiler/doc
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2017-09-15 10:16:34 +0200
committerGitHub <[email protected]>2017-09-15 10:16:34 +0200
commit482120c97dc5c0419b92b6a5621886908abfd837 (patch)
tree7b21a03f7db55e911d2e1e8981daebd056e74516 /lib/compiler/doc
parentb991746008c0bd58b99dbff3ca4be99004798e03 (diff)
parent9bac40fb969bc23f0aa4e90618835fbd95b4dabc (diff)
downloadotp-482120c97dc5c0419b92b6a5621886908abfd837.tar.gz
otp-482120c97dc5c0419b92b6a5621886908abfd837.tar.bz2
otp-482120c97dc5c0419b92b6a5621886908abfd837.zip
Merge pull request #1558 from josevalim/jv-compile-info
Add compile_info option to compile OTP-14615
Diffstat (limited to 'lib/compiler/doc')
-rw-r--r--lib/compiler/doc/src/compile.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml
index 10164890f2..b398871ddf 100644
--- a/lib/compiler/doc/src/compile.xml
+++ b/lib/compiler/doc/src/compile.xml
@@ -123,6 +123,17 @@
in the Efficiency Guide.</p>
</item>
+ <tag><c>{compile_info, [{atom(), term()}]}</c></tag>
+ <item>
+ <p>Allows compilers built on top of <c>compile</c> to attach
+ extra compilation metadata to the <c>compile_info</c> chunk
+ in the generated beam file.</p>
+
+ <p>It is advised for compilers to remove all non-deterministic
+ information if the <c>deterministic</c> option is supported and
+ it was supplied by the user.</p>
+ </item>
+
<tag><c>compressed</c></tag>
<item>
<p>The compiler will compress the generated object code,