From: Nicholas Nethercote <njn@valgrind.org>
Date: Mon, 15 Aug 2005 04:34:20 +0000 (+0000)
Subject: some more info in the QSG
X-Git-Tag: svn/VALGRIND_3_1_0~598
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5492bb9c86280cb7e463e0450f0ef002382e303b;p=thirdparty%2Fvalgrind.git

some more info in the QSG



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4420
---

diff --git a/docs/xml/quick-start-guide.xml b/docs/xml/quick-start-guide.xml
index b4d2dc93bc..c083dcf29e 100644
--- a/docs/xml/quick-start-guide.xml
+++ b/docs/xml/quick-start-guide.xml
@@ -40,7 +40,10 @@ right for earlier versions.</para>
 <title>Preparing your program</title>
 <para>Compile your program with <computeroutput>-g</computeroutput> to include
 debugging information so that Memcheck's error messages include exact line
-numbers.</para>
+numbers.  Using <computeroutput>-O0</computeroutput> is also a good idea;
+with <computeroutput>-O1</computeroutput> line numbers in error messages can
+be inaccurate, and with <computeroutput>-O2</computeroutput> Memcheck
+occasionally reports undefined error messages incorrectly.</para>
 </sect1>
 
 <sect1 id="quick-start.mcrun"