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