remove unused include file: inttypes.h

[fw/openocd] / BUGS

diff --git a/BUGS b/BUGS
index 5c9569cb6b656d3d4cf77183d22c7a041f5a7af8..57a538438e2ea9909fec7de79d148b87bf236562 100644 (file)
--- a/BUGS
+++ b/BUGS
@@ -1,34 +1,49 @@
-Please report bugs by posting a message to 
+/** @page bugs Bug Reporting

 
 

-openocd-development@lists.berlios.de.
+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
 
 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
+items below are unnecessary for a clear bug report, you

 leave them out.
 
 leave them out.
 

-

 - Target PCB/board description
 - Config scripts
 - OpenOCD command line
 - List of commands issued or GDB operations performed
 - Expected result
 - Actual result
 - 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.
+- 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:
-
-gdb --args openocd ....
+- 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.
 (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.

 
 

-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
+ */
+/** @file
+This file contains the @ref bugs page.
+*/