-// This file is part of the Doyxgen Developer Manual
+// This file is part of the Doxygen Developer Manual
/** @page bugs Bug Reporting
Please report bugs by subscribing to the OpenOCD mailing list and
posting a message with your report:
- openocd-development@lists.berlios.de
+ openocd-devel@lists.sourceforge.net
+
+Also, please check the bug database to see if a ticket for
+the bug has already been opened. You might be asked to open
+such a ticket, or to update an existing ticket with more data.
+
+ http://bugs.openocd.org/
To minimize work for OpenOCD developers, you should try to include
all of the information listed below. If you feel that some of the
- 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
-for that process.
+solve the reported problem. See the HACKING file for information
+about that process.
Attach all files directly to your posting. The mailing list knows to
transform attachments to links, but attachments must be less than 300KB
@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