X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=BUGS;h=57a538438e2ea9909fec7de79d148b87bf236562;hb=dbbc9c41f7db210b0a4e226540a28e0a8a5019bf;hp=612b32383f3e38a69815e19d1f01903afb7d9146;hpb=1ad9179f3ae492dceb12d7a6a8ffe6e863731f48;p=openocd.git

diff --git a/BUGS b/BUGS
index 612b32383f..57a538438e 100644
--- a/BUGS
+++ b/BUGS
@@ -1,28 +1,49 @@
-Please report bugs by posting a message to 
-
-openocd-development@lists.berlios.de.
-
-To minimize work for OpenOCD developers, you can include
-all the information below.  If you feel that some of the
-items below are unecessary for a clear bug report, you
-leave them out.
-
-
-- Target PCB/board description
-- Config scripts
-- OpenOCD command line
-- List of commands issued or GDB operations performed
-- Expected result
-- Actual result
-- debug_level 3 logs
-- If this is a regression, include logs for working and broken
-version
-- If this is a regression, please find out the precise version
-that caused the regression. This can be done via a binary
-search. E.g. if version 550 worked and 600 failed, then try
-575, etc.
-
-
-attach files directly to the posting. The mailing list knows to 
-transform attachments to links so you will not be bloating anyones
-mail box. Keep attachments to <100kBytes.
\ No newline at end of file
+/** @page bugs Bug Reporting
+
+Please report bugs by subscribing to the OpenOCD mailing list and
+posting a message with your report:
+
+	openocd-development@lists.berlios.de
+
+To minimize work for OpenOCD developers, you can include
+all the information below.  If you feel that some of the
+items below are unnecessary for a clear bug report, you
+leave them out.
+
+- Target PCB/board description
+- Config scripts
+- OpenOCD command line
+- List of commands issued or GDB operations performed
+- Expected result
+- Actual result
+- Logs using @c debug_level 3 (e.g. add '-d 3' to the command line)
+- If this is a regression, include logs for working and broken version
+- If this is a regression, please find out the precise version that
+  caused the regression.  This can be done via a binary search; For
+  example: if testing version 550 works but 600 fail, then try 575, etc.
+
+- If OpenOCD is crashing, you can use GDB to get a trace:@par
+@code
+% gdb --args openocd ....
+(gdb) run
+(gdb) bt
+=> here a stack trace is dumped.
+@endcode
+
+- To run or debug the in-tree executable (not recommended), you must
+  use libtool to set up the correct shared library paths:
+@code
+  libtool gdb --args openocd ....
+@endcode
+or the more pedantic (and forward-compatible):
+@code
+  libtool --mode=execute gdb --args openocd ....
+@endcode
+- Attach files directly to the posting.  The mailing list knows to
+transform attachments to links so you will not be bloating anyones mail
+box.  Please keep attachments to less than 100KB.
+
+ */
+/** @file
+This file contains the @ref bugs page.
+*/