Changes between Version 17 and Version 18 of ReportBugs

Timestamp:

Sep 21, 2012, 9:15:50 AM (13 years ago)

Author:

davea

Comment:

--

ReportBugs

@@ -3 +3 @@
 = Reporting bugs =
 
-The BOINC client software consists of two programs: the '''client''',
-which runs applications and does network communication, and the '''Manager''',
-which provides a graphical user interface (GUI) to the core client.
+To report a bug, email the [mlist:boinc_alpha boinc_alpha] email list
+or directly to [ProjectPeople David and Rom].
+'''Note: when you post to boinc_alpha, attachments are stripped from your email;
+include text inline rather than as attachments.
+There's a 1 MB limit.'''
+Please include:
+  * The context: what platform, what version of BOINC, anything else that might be relevant.
+  * What sequence of actions caused the problem.
+  * The exact nature of the problem.
+  * The relevant parts of your message logs (see below).
 
-In general we're only interested in bug reports for the current public release, or for the latest testing release.
+'''If you don't include this information, we probably won't be able to fix the bug.'''.
+In general we're only interested in bug reports for the current public release,
+or for the latest testing release.
 
-== Manager bugs ==
+== Crashes ==
 
-If the manager crashes, look for the file '''stderrgui.txt''' in the BOINC data directory.
-It should have information about where the crash occurred.
-Email [ProjectPeople David and Rom], describing the situation and attaching this file.
+The BOINC client software consists of two programs:
+ * the '''client''', which runs applications and does network communication;
+ * the '''manager''', which provides a graphical user interface (GUI) to the client.
 
-For other manager problems, write to the [mlist:boinc_alpha boinc_alpha email list.].
+On windows, these are called '''boinc.exe''' and '''boincmgr.exe''' respectively.
 
-== Client bugs ==
+Usually if the Manager shows "can't connect" it means the client has crashed.
+You can verify this as follows.
+Windows: run the Task Manager (ctrl-shift-esc) and check that there's no process named 'boinc.exe'.
+!Mac/Linux: run {{{ps}}} and check that there's no process named 'boinc'.
 
-The best way to report client problems is to reproduce them using the
+If the client or manager crashes, information about
+the crash is written to a file in the BOINC data directory:
+'''stderrgui.txt''' for the manager, '''stderrdae.txt''' for the client.
+Email [ProjectPeople David and Rom],
+describing the situation and attaching the relevant file.
+
+== Work-fetch and task scheduling bugs ==
+
+The most common client problems involve
+
+ * '''work fetch''': deciding when to request tasks,
+   what project to request from, and how much work to request.
+ * '''task scheduling''': deciding what tasks to run at a given point.
+
+The best way to report these types problems is to reproduce them using the
 [http://boinc.berkeley.edu/dev/sim_web.php BOINC Client Emulator],
 then send us a link to the result.
@@ -25 +51 @@
 which generally makes it easy to fix.
 
+If the emulator doesn't reproduce the bug,
+tell [ProjectPeople David]; we may need to improve the emulator.
 If you can't reproduce the problem with the emulator:
-
- * Report it to [ProjectPeople David]; we may need to improve the emulator.
- * If the client is crashing,
-   check for a file '''stderrgui.txt''' in the BOINC data directory.
-   Email [ProjectPeople David and Rom], describing the situation and attaching this file.
-   Usually if the Manager shows "not connect" it means the client has crashed.
-   You can verify this as follows.
-   Windows: run the Task Manager (ctrl-shift-esc) and check that there's not process named 'boinc.exe'.
-   Mac/Linux: run {{{ps}}} and check that there's not process named 'boinc'.
- * For non-crashing problems, email the [mlist:boinc_alpha boinc_alpha] email list or directly to [ProjectPeople David and Rom].
-   '''Note: when you post to boinc_alpha, attachments are stripped from your email; include text inline rather than as attachments.
-   There's a 1 MB limit.'''
-   Your bug report should include:
-  * The context: what platform, what version of BOINC, anything else that might be relevant.
-  * What sequence of actions caused the problem.
-  * The exact nature of the problem.
-  * The relevant parts of your message logs (see below). '''If you don't include this information, we probably won't be able to fix the bug.'''.
 
 == Message logs ==