Improve BUGS file wording and layout.
[openocd.git] / BUGS
1 /** @page bugs Bug Reporting
2
3 Please report bugs by subscribing to the OpenOCD mailing list and
4 posting a message with your report:
5
6         openocd-development@lists.berlios.de
7
8 To minimize work for OpenOCD developers, you should try to include
9 all of the information listed below.  If you feel that some of the
10 items below are unnecessary for a clear bug report, you may leave
11 them out; likewise, feel free to include additional information
12 that may be important.
13
14 - Target PCB/board description
15 - Configuration scripts
16 - OpenOCD command line
17 - List of commands issued or GDB operations performed
18 - Expected result
19 - Actual result
20 - Logs using <code>debug_level 3</code> (or with '-d 3' on the command line)
21 - If the report is for a regression:
22   - Include logs for both working and broken versions.
23   - Find the precise version that caused the regression by binary search.
24     For example: if testing version 550 works but 600 fail, then try 575, etc.
25
26 If possible, please develop and attach a patch that helps to expose or
27 solve the reported problem.  See the PATCHES file for more information
28 for that process.
29
30 Attach all files directly to your posting.  The mailing list knows to
31 transform attachments to links, but attachments must be less than 300KB
32 in total.
33
34 @section bugscrashdump Obtaining Crash Backtraces
35
36 If OpenOCD is crashing, you can use GDB to get a trace:@par
37 @code
38 % gdb --args openocd ....
39 (gdb) run
40 (gdb) bt
41 => here a stack trace is dumped.
42 @endcode
43
44 @section bugsintreedebug Running and Debugging In-Tree
45
46 To run or debug the in-tree executable (not recommended), you must
47 use libtool to set up the correct shared library paths:
48 @code
49   libtool gdb --args openocd ....
50 @endcode
51 or the more pedantic (and forward-compatible):
52 @code
53   libtool --mode=execute gdb --args openocd ....
54 @endcode
55
56  */
57 /** @file
58 This file contains the @ref bugs page.
59 */