X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=BUGS;h=0cb99ae63de3721d119541d9d7aade9b5525b11c;hp=52ee6405c9b1d7a5dc850156432d4cf29a2661c2;hb=0a9daddc2e20d9ff5053a9faf3e1ec11fd600c73;hpb=5195405da8d872437bb66668f8aa0de1507b979e diff --git a/BUGS b/BUGS index 52ee6405c9..0cb99ae63d 100644 --- 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,8 @@ 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: + http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html 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 +35,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