]> granicus.if.org Git - clang/commitdiff
Document -f{no-}color-diagnostics
authorDouglas Gregor <dgregor@apple.com>
Fri, 9 Jul 2010 16:31:58 +0000 (16:31 +0000)
committerDouglas Gregor <dgregor@apple.com>
Fri, 9 Jul 2010 16:31:58 +0000 (16:31 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@107985 91177308-0d34-0410-b5e6-96231b3b80d8

docs/UsersManual.html

index 049711abf83aeb460d11121dd30c2cfdef3f895d..51e699fc32cbce8d7bdb1f6b809eb582032b28c4 100644 (file)
@@ -251,11 +251,28 @@ when this is enabled, Clang will print something like:</p>
 <p>When this is disabled, Clang will just print:</p>
 
 <pre>
-  test.c:28:8: warning: extra tokens at end of #endif directive [-Wextra-tokens]
+  <b><font color="black">test.c:28:8: <font color="magenta">warning</font>: extra tokens at end of #endif directive [-Wextra-tokens]</font></b>
+  #endif bad
+         <font color="green">^</font>
+         <font color="green">//</font>
 </pre>
 
 </dd>
 
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<dt id="opt_fcolor_diagnostics"><b>-f[no-]color-diagnostics</b>: </dt>
+<dd>This option, which defaults to on when a color-capable terminal is
+  detected, controls whether or not Clang prints diagnostics in color.
+  When this option is enabled, Clang will use colors to highlight
+  specific parts of the diagnostic, e.g.,
+<pre>
+<test.c:2:8: warning: extra tokens at end of #endif directive [-Wextra-tokens]
+#endif bad
+       ^
+       //
+</pre>
+</dd>'
 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
 <dt id="opt_fdiagnostics-show-option"><b>-f[no-]diagnostics-show-option</b>:
 Enable <tt>[-Woption]</tt> information in diagnostic line.</dt>