[cfe-commits] r68210 - /cfe/trunk/www/diagnostics.html

[Douglas Gregor]

Author: dgregor
Date: Wed Apr  1 11:24:40 2009
New Revision: 68210

URL: http://llvm.org/viewvc/llvm-project?rev=68210&view=rev
Log:
Add some examples of Fix-it hints to our documentation

Modified:
    cfe/trunk/www/diagnostics.html

Modified: cfe/trunk/www/diagnostics.html
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/www/diagnostics.html?rev=68210&r1=68209&r2=68210&view=diff

==============================================================================
--- cfe/trunk/www/diagnostics.html (original)
+++ cfe/trunk/www/diagnostics.html Wed Apr  1 11:24:40 2009
@@ -200,8 +200,37 @@
 
 <h2>Fix-it Hints</h2>
 
-<p>simple example + template<> example</p>
+<p>"Fix-it" hints provide advice for fixing small, localized problems
+in source code. When Clang produces a diagnostic about a particular
+problem that it can work around (e.g., non-standard or redundant
+syntax, missing keywords, common mistakes, etc.), it may also provide
+specific guidance in the form of a code transformation to correct the
+problem. For example, here Clang warns about the use of a GCC
+extension that has been considered obsolete since 1993:</p>
 
+<pre>
+  $ <b>clang t.c</b>
+  t.c:5:28: warning: use of GNU old-style field designator extension
+  <font color="darkgreen">struct point origin = { x: 0.0, y: 0.0 };</font>
+                          <font color="red">~~</font> <font color="blue">^</font>
+                          <font color="darkgreen">.x = </font>
+  t.c:5:36: warning: use of GNU old-style field designator extension
+  <font color="darkgreen">struct point origin = { x: 0.0, y: 0.0 };</font>
+                                  <font color="red">~~</font> <font color="blue">^</font>
+                                  <font color="darkgreen">.y = </font>
+</pre>
+
+<p>The underlined code should be removed, then replaced with the code below the caret line (".x =" or ".y =", respectively). "Fix-it" hints are most useful for working around common user errors and misconceptions. For example, C++ users commonly forget the syntax for explicit specialization of class templates, as in the following error:</p>
+
+<pre>
+  $ <b>clang t.cpp</b>
+  t.cpp:9:3: error: template specialization requires 'template<>'
+    struct iterator_traits<file_iterator> {
+    <font color="blue">^</font>
+    <font color="darkgreen">template<> </font>
+</pre>
+
+<p>Again, after describing the problem, Clang provides the fix--add <code>template<></code>--as part of the diagnostic.<p>
 
 <h2>Automatic Macro Expansion</h2>