Docs: Add a tips section to REPORTING-BUGS.
Sarah Sharp [Sun, 14 Apr 2013 01:25:13 +0000 (18:25 -0700)]
Lots of grumpy maintainers would love to have annoying newbies and
disorganized bug reporters read Eric S. Raymond's "How To Ask Questions
The Smart Way".  Simon Tatham's "How to Report Bugs Effectively" is also
relevant.

It's likely no one will bother to read these, but it does give
maintainers something to point to.

Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>

REPORTING-BUGS

index 327b33b..d397e91 100644 (file)
@@ -64,6 +64,19 @@ information on the linux-kernel mailing list see
 http://www.tux.org/lkml/).
 
 
+Tips for reporting bugs
+-----------------------
+
+If you haven't reported a bug before, please read:
+
+http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
+http://www.catb.org/esr/faqs/smart-questions.html
+
+It's REALLY important to report bugs that seem unrelated as separate email
+threads or separate bugzilla entries.  If you report several unrelated
+bugs at once, it's difficult for maintainers to tease apart the relevant
+data.
+
 [Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ]
 
 Gather information