=================================================================== RCS file: /cvsrepo/anoncvs/cvs/www/report.html,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- www/report.html 2000/03/25 02:29:50 1.7 +++ www/report.html 2000/09/17 23:48:35 1.8 @@ -54,6 +54,58 @@
+

How to create a problem report.

+ +Always provide as much information as possible. +The following items should be contained in every bug report: +
    +

    +

  1. The exact sequence of steps from startup necessary to reproduce + the problem. This should be self-contained; it is not enough to send in + a bare command without the arguments and other data you supplied to it. + If a bug requires a particular sequence of events, please list those. + You are encouraged to minimize the size of your example, but this is + not absolutely necessary. If the bug is reproduceable, we'll find it + either way. +

    +

  2. The output you got. Please do not say that it "didn't work" or + "failed". If there is an error message, show it, even if you don't + understand it. If OpenBSD panics with a particular error, say which. + If nothing at all happens, say so. Even if the result + of your test case is a program crash or otherwise obvious it might not + happen in our testing. The easiest thing is to copy the output from + the terminal, if possible. +

    + + Note: In case of fatal errors, the error message provided + might not contain all the information available. + In that case, also look at the output in the system log files, + such as those stored in /var/log. Also, if you are dealing with + an application that has its own log files, such as httpd, check + for errors where it keeps its logs (in the case of httpd, this + is /var/www/logs). + +

    +

  3. The OpenBSD kernel output. You can get this with the dmesg command, + but it is possible that your dmesg output does not contain all the + information that is captured in /var/run/dmesg.boot. If this is the + case, include information from both. Please include this + in all bug reports. +

    +

  4. If you run third-party software which has to do with your bug, say so, including any + subversion that software may have. If you are talking about a CVS or FTP + snapshot, mention that, including its date and time. + +
+

+Do not be afraid if your bug report becomes rather lengthy. That is a fact +of life. It's better to report everything the first time than us having to +squeeze the facts out of you. On the other hand, if your input files are +huge, it is fair to ask first whether somebody is interested in looking into +it. +

+Finally, when writing a bug report, please choose non-confusing terminology. +

Sending in bug reports.

@@ -98,8 +150,7 @@ OpenBSD www@openbsd.org -
$OpenBSD: report.html,v 1.7 2000/03/25 02:29:50 wvdputte Exp $ - +
$OpenBSD: report.html,v 1.8 2000/09/17 23:48:35 chris Exp $