Changes between Version 7 and Version 8 of HowToFileABug

Timestamp:

2010-07-28T08:48:21Z (14 years ago)

Author:

Jakub Jermář

Comment:

—

HowToFileABug

@@ -1 +1 @@
 = How to file a bug =
 
-As in any other complex software system, there will inevitably be bugs in the HelenOS source code (unless we can formally prove the opposite). It is therefore essential for people who run into them to make sure the bug is actually known to the developers and that all potentially relevant information that can help to root-cause the bug is available. This is best achieved by [/newticket filing a ticket] in our [report:{1} bug tracking database].
+As in any other complex software system, there will inevitably be bugs in the HelenOS source code (unless we can formally prove the opposite). It is therefore essential for people who run into them to make sure the bug is actually known to the developers and that all potentially relevant information that can help to root-cause the bug is available. This is best achieved by [/newticket filing a ticket] in our [report:1 bug tracking database].
 
 Writing bug reports is by far not that trivial as it may initially seem. Quite the contrary. Writing really good bug reports takes some effort and needs some practice, but the reward is high.  The ticket owner can then focus on solving the bug itself rather than figuring out all the information and circumstances that lead to it. Below follows a list of tips for filing the most useful bug reports.
@@ -27 +27 @@
     * Provide reasonable details about HelenOS configuration
       * consider attaching Makefile.config from the root of the HelenOS tree
-      * Say whether HelenOS was built with the recent toolchain.sh script or not
+      * Say whether HelenOS was built with the recent [source:mainline/tools/toolchain.sh toolchain.sh] script or not
         * Building with native toolchain is strongly discouraged. Please make sure that the bug is still reproducible using the supported toolchain before filing the bug. If you really think that logging a bug which is only reproducible with the native toolchain is justifiable, then please state versions of the used compiler, assembler and linker.
     * If there is a stack trace associated with the bug, paste it into the bug report