From: Evan Cheng <evan.cheng@apple.com>
Date: Fri, 8 Apr 2011 22:18:01 +0000 (+0000)
Subject: Document -ftrap-function= option
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fda026bc46464cddd5287da5da08183127a844e9;p=clang

Document -ftrap-function= option

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@129162 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/UsersManual.html b/docs/UsersManual.html
index 2b7b148975..661be80f9d 100644
--- a/docs/UsersManual.html
+++ b/docs/UsersManual.html
@@ -767,6 +767,18 @@ Don't assume that the C++'s new operator is sane.</dt>
 <dd>This option tells the compiler to do not assume that C++'s global new
 operator will always return a pointer that does not
 alias any other pointer when the function returns.</dd>
+
+<dt id="opt_ftrap-function=<name>"><b>-ftrap-function=<name></b>: Instruct code
+generator to emit a function call to the specified function name for
+<tt>__builtin_trap()</tt>.</dt>
+
+<dd>LLVM code generator translates <tt>__builtin_trap()</tt> to a trap
+instruction if it is supported by the target ISA. Otherwise, the builtin is
+translated into a call to <tt>abort</tt>. If this option is set, then the code
+generator will always lower the builtin to a call to the specified function
+regardless of whether the target ISA has a trap instruction. This option is
+useful for environements (e.g. deeply embedded) where a trap cannot be properly
+handled.
 </dl>
 
 <!-- ======================================================================= -->