Changes between Version 6 and Version 7 of HowToFileABug

Timestamp:

2010-07-28T08:38:27Z (14 years ago)

Author:

Jakub Jermář

Comment:

Improvements.

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 filing a ticket in our 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.
 
   * Make sure the bug is not a duplicate of some other bug
-    * If it is, consider improving the original bug report, but don't file any new ticket
+    * If it is, consider improving the original bug report by providing additional data, but don't file any new ticket
+    * If in doubt, then please do file a new ticket.
   * Pick a descriptive ```Summary```
     * '''bad''': ''HelenOS has bugs''
@@ -17 +18 @@
     * Say what deviation from the expected behavior you observe
     * Briefly say what you think the expected behavior should be
-    * Include instructions, code fragments to reproduce the problem or state that the problem is not easily reproducible
-    * If you set the ```Version``` field to ''mainline'', provide the exact revision of the changeset where the bug was observed
-      * If the bug was observed in multiple revisions, specify the first one in which the problem occurred
+    * Include instructions and/or code fragments to reproduce the problem or state that the problem is not easily reproducible
+    * If you set the ```Version``` field to ''mainline'', provide the exact changeset in which the bug was observed
+      * If the bug was observed in multiple changesets, specify the first one in which the problem was observed
     * Provide reasonable details about the hardware of the target system, such as:
       * the processor architecture, if not already clear from the ```Component``` field
@@ -26 +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
+        * 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
       * In case there is a core dump generated for a crashing task, compress it and attach it to the ticket