Factor version munging capabilities out of release.sh.

[openocd] / BUGS

diff --git a/BUGS b/BUGS
index 52ee6405c9b1d7a5dc850156432d4cf29a2661c2..d22417776b4f3cb2309747e42ac4605bc5cb5674 100644 (file)
--- a/BUGS
+++ b/BUGS
@@ -1,3 +1,4 @@
+// This file is part of the Doyxgen Developer Manual
 /** @page bugs Bug Reporting
 
 Please report bugs by subscribing to the OpenOCD mailing list and
@@ -21,7 +22,7 @@ that may be important.
 - If the report is for a regression:
   - Include logs for both working and broken versions.
   - Find the precise version that caused the regression by binary search.
-    For example: if testing version 550 works but 600 fail, then try 575, etc.
+    You can use "git bisect" to expedite this binary search.
 
 If possible, please develop and attach a patch that helps to expose or
 solve the reported problem.  See the PATCHES file for more information
@@ -33,8 +34,15 @@ in total.
 
 @section bugscrashdump Obtaining Crash Backtraces
 
-If OpenOCD is crashing, you can use GDB to get a trace:@par
+If OpenOCD is crashing, there are two very effective things you can do to
+improve your chances of getting help on the development mailing list. 
+
+Try to reproduce the problem using the dummy JTAG interface to allow other developers to replicate
+your problem robustly and use GDB to get a trace:@par
 @code
+% OPENOCDSRC/configure --enable-dummy ...
+% openocd -f interface/dummy.cfg -f target/xxx.cfg
+=> SEGFAULT
 % gdb --args openocd ....
 (gdb) run
 (gdb) bt