|
From: <sv...@va...> - 2009-06-25 22:50:21
|
Author: njn
Date: 2009-06-25 23:50:13 +0100 (Thu, 25 Jun 2009)
New Revision: 398
Log:
Improve bug-reporting instructions. In particular, improve the description
of how to search for an existing bug, and point them at the simple seach
form instead of the intimidating advanced search.
Modified:
trunk/php/.htconfx
trunk/support/bug_reports.html
Modified: trunk/php/.htconfx
===================================================================
--- trunk/php/.htconfx 2009-06-25 05:13:08 UTC (rev 397)
+++ trunk/php/.htconfx 2009-06-25 22:50:13 UTC (rev 398)
@@ -45,7 +45,7 @@
'url'=>'http://bugs.kde.org/enter_valgrind_bug.cgi' ),
'vgbugsquery' => array(
'txt'=>'Bugzilla query',
- 'url'=>'http://bugs.kde.org/query.cgi' ),
+ 'url'=>'http://bugs.kde.org/query.cgi?format=specific' ),
'vgbugsopenlist' => array(
'txt'=>'Bugzilla all open bugs',
'url'=>'http://bugs.kde.org/buglist.cgi?product=valgrind&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&cmdtype=doit' ),
Modified: trunk/support/bug_reports.html
===================================================================
--- trunk/support/bug_reports.html 2009-06-25 05:13:08 UTC (rev 397)
+++ trunk/support/bug_reports.html 2009-06-25 22:50:13 UTC (rev 398)
@@ -10,20 +10,36 @@
workaround. This includes a large fraction of the failures people seem to
encounter in practice.</p>
-<p>After that, please search to see if the bug has already been reported
-using the <?php echo vglink( 'vgbugsquery' ); ?> page (make sure you choose
-Valgrind as the "product"), or by viewing all open bug reports at the
-<?php echo vglink( 'vgbugsopenlist' ); ?> page. Anyone can search the
-database. Searching requires some effort, but helps avoid duplicates, and
-you may find that your problem has already been solved.</p>
+<p>After that, please search Bugzilla to see if the bug has already been
+reported. There are two ways to do this:
+<ul>
+ <li>Using the <?php echo vglink( 'vgbugsquery' ); ?> page; choose
+ Valgrind as the "product", and then type something relevant in the "words"
+ box. If you are seeing a crash or abort, searching for part of the abort
+ message might be effective. If you are feeling adventurous you can select
+ the "Advanced search" tab; this gives a lot more control but isn't much
+ better for finding existing bugs.</li>
+
+ <li>Or you can view all open Valgrind bug reports at the
+ <?php echo vglink( 'vgbugsopenlist' ); ?> page, and use your browser's
+ search facilities to search through them.</li>
+<ul>
+</p>Note that KDE kindly lets us use their Bugzilla, which explains the URLs
+of those pages and all the mentions of KDE.</p>
+<p>Anyone can search in Bugzilla, you don't need an account. Searching
+requires some effort, but helps avoid duplicates, and you may find that your
+problem has already been solved.</p>
+
+
<h2>Reporting a Bug</h2>
<p>If you haven't encountered your problem after those steps, please file a
report using our <?php echo vglink( 'vgbugsreport' ); ?> page. You need a
-Bugzilla account (instructions for creating one are on the page) to report a
-bug.</p>
+KDE Bugzilla account to report a bug; instructions for creating one are on
+the page. Creating an account takes some time and effort, but it's a
+necessary evil when using Bugzilla.</p>
<p>The bug report form can be intimidating. Fortunately you don't have to
fill in all the fields. Leave all fields blank except the following:</p>
@@ -37,9 +53,8 @@
<li><strong>Version:</strong> The version number is shown when Valgrind
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>
+ instrumentation framework" line. An "SVN"-suffixed version will only
+ appear if you are using code directly from the SVN repository.</li>
<li><strong>Severity:</strong> If Valgrind won't copile, choose "major".
If you are seeing a crash, choose "crash". If your problem is minor,
|