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.

68 lines
2.2 KiB

  1. // This file is part of the Doyxgen 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:
  6. To minimize work for OpenOCD developers, you should try to include
  7. all of the information listed below. If you feel that some of the
  8. items below are unnecessary for a clear bug report, you may leave
  9. them out; likewise, feel free to include additional information
  10. that may be important.
  11. - Target PCB/board description
  12. - Configuration scripts
  13. - OpenOCD command line
  14. - List of commands issued or GDB operations performed
  15. - Expected result
  16. - Actual result
  17. - Logs using <code>debug_level 3</code> (or with '-d 3' on the command line)
  18. - If the report is for a regression:
  19. - Include logs for both working and broken versions.
  20. - Find the precise version that caused the regression by binary search.
  21. You can use "git bisect" to expedite this binary search.
  22. If possible, please develop and attach a patch that helps to expose or
  23. solve the reported problem. See the PATCHES file for more information
  24. for that process.
  25. Attach all files directly to your posting. The mailing list knows to
  26. transform attachments to links, but attachments must be less than 300KB
  27. in total.
  28. @section bugscrashdump Obtaining Crash Backtraces
  29. If OpenOCD is crashing, there are two very effective things you can do to
  30. improve your chances of getting help on the development mailing list.
  31. Try to reproduce the problem using the dummy JTAG interface to allow other developers to replicate
  32. your problem robustly and use GDB to get a trace:@par
  33. @code
  34. % OPENOCDSRC/configure --enable-dummy ...
  35. % openocd -f interface/dummy.cfg -f target/xxx.cfg
  36. => SEGFAULT
  37. % gdb --args openocd ....
  38. (gdb) run
  39. (gdb) bt
  40. => here a stack trace is dumped.
  41. @endcode
  42. @section bugsintreedebug Running and Debugging In-Tree
  43. To run or debug the in-tree executable (not recommended), you must
  44. use libtool to set up the correct shared library paths:
  45. @code
  46. libtool gdb --args openocd ....
  47. @endcode
  48. or the more pedantic (and forward-compatible):
  49. @code
  50. libtool --mode=execute gdb --args openocd ....
  51. @endcode
  52. */
  53. /** @file
  54. This file contains the @ref bugs page.
  55. */