From afa36d2081927c46a4c3ddceb40276fc7756bb51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20H=C3=B6gberg?= <john@erlang.org>
Date: Mon, 24 Sep 2018 08:03:21 +0200
Subject: hipe: Document new limitations and disable known failing tests

---
 lib/hipe/doc/src/hipe_app.xml | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'lib/hipe/doc/src/hipe_app.xml')

diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/hipe_app.xml
index 99759a2f2c..480290cd9e 100644
--- a/lib/hipe/doc/src/hipe_app.xml
+++ b/lib/hipe/doc/src/hipe_app.xml
@@ -62,6 +62,13 @@
       and the runtime system that have limited or no support for HiPE compiled modules.
     </p>
     <taglist>
+      <tag>Binary matching</tag>
+      <item><p>The HiPE compiler will crash on modules containing binary
+      matching unless they have been compiled with the <c>+no_bsm3</c> flag.
+      Note that this will disable all related optimizations done by the BEAM
+      compiler.</p>
+      </item>
+
       <tag>Stack traces</tag>
       <item><p>Stack traces returned from <seealso marker="erts:erlang#get_stacktrace/0">
       <c>erlang:get_stacktrace/0</c></seealso> or as part of <c>'EXIT'</c> terms
-- 
cgit v1.2.3