Changes between Version 9 and Version 10 of HowToFileABug

Timestamp:

2016-01-10T01:39:24Z (9 years ago)

Author:

Martin Decky

Comment:

improve grammar

HowToFileABug

@@ -1 @@
-= How to file a bug =
+= 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 point to the root cause of 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 by providing additional data, but don't file any new ticket
+  * Make sure the bug is not a duplicate of some other bug.
+    * If it is, consider improving the original bug report by providing additional data, but don't file a new ticket.
     * If in doubt, then please do file a new ticket.
-  * Pick a descriptive ```Summary```
+  * Pick a descriptive ```Summary```.
     * '''bad''': ''HelenOS has bugs''
     * '''good''': ''page_ht_lock mutex taken while tlblock spinlock held''
-  * Avoid creating multi-tickets
+  * Avoid creating multi-tickets.
     * '''bad''': ''Fix problem XYZ on amd64, arm32, ia32, ia64, mips32, ppc32 and sparc64''
-    * Instead, consider filing separate tickets for all of the above architectures. This will make it easier to track progress on each architecture separately
-  * Categorize the new bug using fitting ```Type```, ```Component``` and ```Version``` fields
-  * In the first comment section, provide a concise and complete problem statement
-    * Say what deviation from the expected behavior you observe
-    * Briefly say what you think the expected behavior should be
-    * 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
+    * Instead, consider filing separate tickets for all of the above architectures. This will make it easier to track progress on each architecture separately.
+  * Categorize the new bug using fitting ```Type```, ```Component``` and ```Version``` fields.
+  * In the first comment section, provide a concise and complete problem statement.
+    * Say what deviation from the expected behavior you observe.
+    * Briefly say what you think the expected behavior should be.
+    * 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
       * number of processors
       * name and version of the simulator/virtualizer, if the target system is a simulated machine
-    * 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 [source:mainline/tools/toolchain.sh toolchain.sh] script or not
+    * 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 [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
-      * Compressing and attaching a screenshot with the stack trace (and other messages) may be an option if the stack trace cannot be easily copied and pasted
-      * In case there is a core dump generated for a crashing task, compress it and attach it to the ticket
-      * Alternatively, attach the compressed binary itself (kernel.raw or the respective uspace binary). Note that attaching .disasm files is problematic as these files are usually much bigger than the respective binaries themselves (even when compressed)
-    * If there are some terminal or console messages of interest such as warnings or errors, mention those in the bug report
+    * If there is a stack trace associated with the bug, paste it into the bug report.
+      * Compressing and attaching a screenshot with the stack trace (and other messages) may be an option if the stack trace cannot be easily copied and pasted.
+      * In case there is a core dump generated for a crashing task, compress it and attach it to the ticket.
+      * Alternatively, attach the compressed binary itself (kernel.raw or the respective user space binary). Note that attaching .disasm files is problematic as these files are usually much bigger than the respective binaries themselves (even when compressed).
+    * If there are some terminal or console messages of interest such as warnings or errors, mention those in the bug report.