From: Alexey Samsonov <samsonov@google.com>
Date: Wed, 30 May 2012 06:55:10 +0000 (+0000)
Subject: Clang docs update: list command-line flags that control the size of generated debug... 
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5ab5249cbf6e6cd97ae7cdcad4236bc8cbd2f064;p=clang

Clang docs update: list command-line flags that control the size of generated debug information. Reviewed by chandlerc@ and echristo@.

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

diff --git a/docs/UsersManual.html b/docs/UsersManual.html
index 07015c8f19..2356b03146 100644
--- a/docs/UsersManual.html
+++ b/docs/UsersManual.html
@@ -49,6 +49,7 @@ td {
   </li>
   <li><a href="#precompiledheaders">Precompiled Headers</a></li>
   <li><a href="#codegen">Controlling Code Generation</a></li>
+  <li><a href="#debuginfosize">Controlling Size of Debug Information</a></li>
  </ul>
 </li>
 <li><a href="#c">C Language Features</a>
@@ -857,6 +858,29 @@ useful for environments (e.g. deeply embedded) where a trap cannot be properly
 handled, or when some custom behavior is desired.</dd>
 </dl>
 
+<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
+<h3 id="debuginfosize">Controlling Size of Debug Information</h3>
+<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
+
+<p>Debug info kind generated by Clang can be set by one of the flags listed
+below. If multiple flags are present, the last one is used.</p>
+
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<dl>
+<dt id="opt_g0"><b>-g0</b>: Don't generate any debug info (default).
+
+<dt id="opt_gline-tables-only"><b>-gline-tables-only</b>:
+Generate line number tables only.
+<dd>
+This kind of debug info allows to obtain stack traces with function
+names, file names and line numbers (by such tools as
+gdb or addr2line). It doesn't contain any other data (e.g.
+description of local variables or function parameters).
+</dd>
+
+<dt id="opt_g"><b>-g</b>: Generate complete debug info.
+</dl>
+
 <!-- ======================================================================= -->
 <h2 id="c">C Language Features</h2>
 <!-- ======================================================================= -->