git.sur5r.net Git - openocd/blob - 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 can include
   9 all the information below.  If you feel that some of the
  10 items below are unnecessary for a clear bug report, you
  11 leave them out.
  12
  13 - Target PCB/board description
  14 - Config scripts
  15 - OpenOCD command line
  16 - List of commands issued or GDB operations performed
  17 - Expected result
  18 - Actual result
  19 - Logs using @c debug_level 3 (e.g. add '-d 3' to the command line)
  20 - If this is a regression, include logs for working and broken version
  21 - If this is a regression, please find out the precise version that
  22   caused the regression.  This can be done via a binary search; For
  23   example: if testing version 550 works but 600 fail, then try 575, etc.
  24
  25 - If OpenOCD is crashing, you can use GDB to get a trace:@par
  26 @code
  27 % gdb --args openocd ....
  28 (gdb) run
  29 (gdb) bt
  30 => here a stack trace is dumped.
  31 @endcode
  32
  33 - To run or debug the in-tree executable (not recommended), you must
  34   use libtool to set up the correct shared library paths:
  35 @code
  36   libtool gdb --args openocd ....
  37 @endcode
  38 or the more pedantic (and forward-compatible):
  39 @code
  40   libtool --mode=execute gdb --args openocd ....
  41 @endcode
  42 - Attach files directly to the posting.  The mailing list knows to
  43 transform attachments to links so you will not be bloating anyones mail
  44 box.  Please keep attachments to less than 100KB.
  45
  46  */
  47 /** @file
  48 This file contains the @ref bugs page.
  49 */