diff README.bugreport @ 1:183e7cbc1036

Initial revision
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 03 Jun 2003 10:23:04 +0000
parents
children e5c49367b899
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.bugreport	Tue Jun 03 10:23:04 2003 +0000
@@ -0,0 +1,79 @@
+Making and sending bugreports
+=============================
+Consider the following things before writing a bug-report.
+
+1. Type of the bug:
+
+- Sound-distortion?
+
+  This may not be directly XMMS-SID bug, but more like SIDPlay bug.
+  Check the SID-tune with SIDPlay commandline player. If the problem
+  shows up there, you should check that the tune itself is not
+  corrupted (or it may even be that it _should_ sound like that).
+
+  The High Voltage SID Collection (HVSC) and SID Tune Information List
+  (STIL) homepages contain tips and guidelines for SID-tune rippers +
+  information on bugged tunes.
+
+  If the tune that sounds bad is available on HVSC, compare it with
+  the one available from latest version of HVSC. Read the HVSC buglists
+  and other informations (the STIL database contains info about bugged
+  tunes)
+
+  Ultimately you should check the tune on a REAL C64, but since many of
+  the younger computer users don't even have the real thing, this may
+  be impossible. (If the tune works on REAL C64, i.e. NOT EMULATOR!!!!
+  it may be a bug in SIDPlay)
+
+
+- Segfault?
+
+  Again, check the tune on commandline SIDPlay. If it also segfaults,
+  report the bug to SIDPlay author, Michael Schwendt.
+
+  If it does NOT segfault with commandline SIDPlay, report it to me (ccr).
+  See README for contacting information.
+
+- New feature?
+
+  Well, check on the commandl... ehh. :-)
+
+  Send the suggestions, shit, hatemail, patches and your valuables to
+  ccr/TNSP, contacting information available on README.
+
+
+
+2. Example-layout for bug-reports
+
+Here is an example layout for your bug-report. Feel free to
+use your own, or put in additional information.
+(Send it via e-mail, using subject: "XMMS-SID BUG")
+
+
+Operating system   :		(uname -a)
+Version/release    :
+Vendor             :
+
+
+XMMS-SID version   :		(XMMS plugin preferences panel)
+
+libsidplay version :		(sidplay -h)
+
+XMMS version       :		(xmms --version)
+
+Are you using songpos-patch?	(if you applied the patch, answer yes)
+
+
+Description of the bug?
+-----------------------
+
+
+How to reproduce the bug?
+-------------------------
+
+
+Other information
+-----------------
+
+[If the bug is/causes a segfault, include a backtrace if possible.]
+