[llvm-commits] CVS: llvm/docs/HowToSubmitABug.html

[Chris Lattner]

Changes in directory llvm/docs:

HowToSubmitABug.html updated: 1.16 -> 1.17

---
Log message:

Add a note to make sure the program is memory correct


---
Diffs of the changes:  (+10 -4)

Index: llvm/docs/HowToSubmitABug.html
diff -u llvm/docs/HowToSubmitABug.html:1.16 llvm/docs/HowToSubmitABug.html:1.17
--- llvm/docs/HowToSubmitABug.html:1.16	Sun Apr 18 22:07:29 2004
+++ llvm/docs/HowToSubmitABug.html	Tue May 11 14:34:27 2004
@@ -230,9 +230,15 @@
 before defining them, etc.) which the verifier will check for after a pass
 finishes its run.</p>
 
-<p>To debug a miscompilation, you should choose which program you wish to run
-the output through, e.g. C backend, the JIT, or LLC, and a selection of passes,
-one of which may be causing the error, and run, for example:</p>
+<p>If it looks like the LLVM compiler is miscompiling a program, the very first
+thing to check is to make sure it is not using undefined behavior.  In 
+particular, check to see if the program valgrinds clean, passes purify, or some
+other memory checker tool.  Many of the "LLVM bugs" that we have chased down
+ended up being bugs in the program being compiled, not LLVM.</p>
+
+<p>Once you determine that the program itself is not buggy, you should choose 
+which code generator you wish to compile the program with (e.g. C backend, the 
+JIT, or LLC) and optionally a series of LLVM passes to run.  For example:</p>
 
 <div class="doc_code">
 <p><tt><b>bugpoint</b> -run-cbe [... optimization passes ...] file-to-test.bc
@@ -334,7 +340,7 @@
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
   <br>
-  Last modified: $Date: 2004/04/19 03:07:29 $
+  Last modified: $Date: 2004/05/11 19:34:27 $
 </address>
 
 </body>