You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

75 lines
2.5KB

  1. // This file is part of the Doxygen Developer Manual
  2. /** @page bugs Bug Reporting
  3. Please report bugs by subscribing to the OpenOCD mailing list and
  4. posting a message with your report:
  5. openocd-devel@lists.sourceforge.net
  6. Also, please check the bug database to see if a ticket for
  7. the bug has already been opened. You might be asked to open
  8. such a ticket, or to update an existing ticket with more data.
  9. http://bugs.openocd.org/
  10. To minimize work for OpenOCD developers, you should try to include
  11. all of the information listed below. If you feel that some of the
  12. items below are unnecessary for a clear bug report, you may leave
  13. them out; likewise, feel free to include additional information
  14. that may be important.
  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. You can use "git bisect" to expedite this binary search:
  26. http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html
  27. If possible, please develop and attach a patch that helps to expose or
  28. solve the reported problem. See the HACKING file for information
  29. about that process.
  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. @section bugscrashdump Obtaining Crash Backtraces
  34. If OpenOCD is crashing, there are two very effective things you can do to
  35. improve your chances of getting help on the development mailing list.
  36. Try to reproduce the problem using the dummy JTAG interface to allow other developers to replicate
  37. your problem robustly and use GDB to get a trace:@par
  38. @code
  39. % OPENOCDSRC/configure --enable-dummy ...
  40. % openocd -f interface/dummy.cfg -f target/xxx.cfg
  41. => SEGFAULT
  42. % gdb --args openocd ....
  43. (gdb) run
  44. (gdb) bt
  45. => here a stack trace is dumped.
  46. @endcode
  47. @section bugsintreedebug Running and Debugging In-Tree
  48. To run or debug the in-tree executable (not recommended), you must
  49. use libtool to set up the correct shared library paths:
  50. @code
  51. libtool gdb --args openocd ....
  52. @endcode
  53. or the more pedantic (and forward-compatible):
  54. @code
  55. libtool --mode=execute gdb --args openocd ....
  56. @endcode
  57. */
  58. /** @file
  59. This file contains the @ref bugs page.
  60. */