|
From: <sv...@va...> - 2009-06-25 04:23:59
|
Author: njn Date: 2009-06-25 05:23:56 +0100 (Thu, 25 Jun 2009) New Revision: 393 Log: Tweak bug reporting instructions some more. Modified: trunk/support/bug_reports.html Modified: trunk/support/bug_reports.html =================================================================== --- trunk/support/bug_reports.html 2009-06-25 04:16:53 UTC (rev 392) +++ trunk/support/bug_reports.html 2009-06-25 04:23:56 UTC (rev 393) @@ -30,20 +30,24 @@ <ul> <li><strong>Component:</strong> If the problem is with a specific Valgrind - tool (eg. Memcheck, Cachegrind), select the tool name. If it's a general - problem that appears tool-independent, select "general".</li> + tool (eg. Memcheck, Cachegrind), select the tool name. If it's a Vex issue + (i.e. an abort message mentions "vex"), select "vex". If it's a general + problem that appears tool-independent, or you are not sure, select + "general".</li> <li><strong>Version:</strong> The version number is shown when Valgrind - starts up. Only use a "SVN"-suffixed version if you are using code from - the SVN repository.</li> + starts up, on the "Using valgrind-$VERSION, a dynamic binary + instrumentation framework" line. Only use a "SVN"-suffixed version if + you are using code from the SVN repository (in which case "SVN" will appear + in the printed version number).</li> - <li><strong>Severity:</strong></li> If you are seeing a crash, choose + <li><strong>Severity:</strong> If you are seeing a crash, choose "crash". If your problem is minor, choose "minor" or "wishlist". Otherwise, choose "normal". Please leave the "major", "grave" or - "critical" categories to the Valgrind developers to decide. + "critical" categories to the Valgrind developers to decide.</li> - <li><strong>Platform:</strong></li> "unspecified" is usually fine; this - field isn't very important. + <li><strong>Platform:</strong> "unspecified" is usually fine; this + field isn't very important unless it's a packaging-related problem.</li> <li><strong>OS:</strong> This is auto-filled. Change it if necessary.</li> @@ -51,8 +55,8 @@ Try to make it precise. E.g. if you get an assertion failure, don't say "assertion failure"; copy in the actual assertion failure message. - <li><p><strong>Description:</strong> The most important field. - Please give the following information:</p> + <li><strong>Description:</strong> The most important field, which + describes the problem. Please include the following information: <ul> <li>The output of <code>uname -a</code>.</li> <li>The full output you get when you run your program under Valgrind @@ -60,7 +64,7 @@ </ul> Note that a bug is much more likely to be fixed if a Valgrind developer can reproduce it. So full reproduction steps are very helpful. - Small test cases are even better.</p> + Small test cases are even better.</li> </ul> <p>Here are some resources on how to write a good bug report, which can help |