From: Kostya Serebryany <kcc@google.com>
Date: Fri, 6 Jan 2012 17:35:27 +0000 (+0000)
Subject: [asan] mention -fno-omit-frame-pointer in the docs
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e683fd9d6f3ca1bbb00b38a1dc9a789fab00967c;p=clang

[asan] mention -fno-omit-frame-pointer in the docs

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

diff --git a/docs/AddressSanitizer.html b/docs/AddressSanitizer.html
index e6f7e99047..3b25f26fec 100644
--- a/docs/AddressSanitizer.html
+++ b/docs/AddressSanitizer.html
@@ -48,6 +48,8 @@ Follow the <a href="../get_started.html">clang build instructions</a>.
 <h2 id="intro">Usage</h2>
 Simply compile and link your program with <tt>-faddress-sanitizer</tt> flag. <BR>
 To get a reasonable performance add <tt>-O1</tt> or higher. <BR>
+To get nicer stack traces in error messages add
+<tt>-fno-omit-frame-pointer</tt>. <BR>
 
 <pre>
 % cat example_UseAfterFree.cc
@@ -59,7 +61,7 @@ int main(int argc, char **argv) {
 </pre>
 
 <pre>
-% clang -O1 -g -faddress-sanitizer example_UseAfterFree.cc
+% clang -O1 -g -faddress-sanitizer -fno-omit-frame-pointer example_UseAfterFree.cc
 </pre>
 
 If a bug is detected, the program will print an error message to stderr and exit with a