From 1e45fa9f85ba61f7ef6f8df8adf2f5ed77e48efe Mon Sep 17 00:00:00 2001 From: gabucino Date: Thu, 21 Mar 2002 06:32:13 +0000 Subject: [PATCH] wording patch by Diego & Egger git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@5238 b3059339-0415-0410-9bf9-f77b7e298cf2 --- DOCS/bugreports.html | 205 +++++++++++++++++++++++-------------------- 1 file changed, 111 insertions(+), 94 deletions(-) diff --git a/DOCS/bugreports.html b/DOCS/bugreports.html index f387bdf3c5..730b5e234a 100644 --- a/DOCS/bugreports.html +++ b/DOCS/bugreports.html @@ -16,112 +16,125 @@

How to report bugs?

-

First, try the latest CVS, maybe your bug is already fixed. CVS download -instructions (easy) can be found on our homepage.

+

First of all please try the latest CVS version of mplayer as your bug might +already be fixed there. CVS instructions can be found at the bottom of +this page.

-

If it didn't help: read Appendix D, and other docs. If your problem isn't -known or isn't solved by our instructions, then report the bug:

+

If this did not help please refer to Appendix D +and the rest of the documentation. If your problem is not known or not solvable by +our instructions, then please report the bug.

-

Where?

+

Where to report bugs?

Subscribe to the mplayer-users mailing list:
    http://mplayerhq.hu/mailman/listinfo/mplayer-users
-and send your bugreport to:
+and send your bug report to:
    mplayer-users@mplayerhq.hu
-We won't CC: so please subscribe!!!

+Please note that we will not individually CC (carbon-copy) people so it is a good +idea to subscribe to actually receive your answer.

-

Don't send bugreports private, directly to author's address!!! -We are working together on code, so everyone is interested in it. -BTW many times other users know the solution (system config probs, -bad drivers etc), even when we think it's a bug in our code. -The language of this list is ENGLISH!

+

Please do not send bug reports privately to individual developers. This is +community work and thus there might be several people interested in it. +Also sometimes other users already experienced your troubles and have a +solution in hand how to circumvent a problem even if it is a bug in mplayer +code.
+The language of this list is English.

-

Please describe your problem in details, examples etc, and don't -forget to include these:

+

Please describe your problem as detailed as possible with examples etc. +and do not forget to include this valuable information:

-

What?

+

What to report?

-

1. The system info what we always want:

+

System Information

-

2. Hardware & drivers:

+

Hardware & drivers

-

For compiling problems/errors

+

For compilation problems/errors

-

3. these files:

+

Please include these files:

-

For playback problems:

+

For playback problems

-

3. Output of mplayer at verbose level 1 (-v)

+

Please include the output of mplayer at verbosity level 1

    mplayer -v [options] filename &> mplayer.log

- -

4. If the problem is specific to one or a few files, - then please upload that file to:

-

   ftp://mplayerhq.hu/MPlayer/incoming/

- Also upload a small .txt file with the same name as your file (+ .txt extension), - containing problem description, mplayer -v file output, and your email address!
- Usually first 1-5 MB of the file is enough to reproduce - the problem, but first you should try it: -

   dd if=yourfile of=smallfile bs=1024k count=5

- (it will cut first 5 MB of 'yourfile' and save to 'smallfile') - Then try again on this small file, and if bug still exists - then it's enough to upload this small file.
- NEVER send such files via mail! Upload it, and send only - the path/filename of the file on the FTP. - If the file is accessible on the net, then sending the - _exact_ URL is enough! -

5. For crashes (segfault, SIGILL, signal 4 etc):

+

If your problem is specific to one or more files, then please upload the +offender(s) to:

-

If you have coredump of the crash, see 5.a, else see 5.b:

+

    ftp://mplayerhq.hu/MPlayer/incoming/

-

5.a: Please print us coredump (if it was created).

+

Also upload a small text file having the same base name as your file +with a .txt extension. Describe the problem you are having with the +particular file there and include your email address as well as the output +of mplayer at verbosity level 1.
+Usually the first 1-5 MB of a file are enough to reproduce the problem, +but to be sure we ask you to: +

    dd if=yourfile of=smallfile bs=1024k count=5

-

Howto: -please create following command file:

+

It will take the first five megabytes of 'your-file' and +write it to 'small-file'.
+Then try again on this small file and if the bug still shows up +your sample is sufficient for us.
+Please do not ever send such files via mail! Upload it, +and send only the path/filename of the file on the FTP-server.
+If the file is accessible on the net, then sending the +exact URL is sufficient.

+ +

For crashes

+ +

If you have a core dump of the crash continue reading the next paragraph, otherwise skip it.

+ +

How to extract meaningful information from a core dump

+ +

Please create following command file:

disass $eip-32 $eip+32
printf "eax=%08lX\n",$eax
@@ -134,41 +147,45 @@ printf "edi=%08lX\n",$edi
printf "esi=%08lX\n",$esi

-

Then simply execute following command line:

-

    gdb mplayer --core=core -batch --command=command_file >mplayer.bug

+

Then simply execute the following on your command line:

+

    gdb mplayer --core=core -batch --command=command_file > mplayer.bug

-

5.b.: run MPlayer in gdb:

-

Re-compile mplayer with debugging code enabled:
-./configure --enable-debug
-make -

-

[at root/user shell prompt:]
-    # gdb mplayer
-[at gdb prompt:]
-    > run -v [options-to-mplayer] filename
- ... (wait until it will crash)
-    > bt
-    > disass $eip-32 $eip+32
-Send us the full output of the above things! -

+

How to conserve information about a reproducible crash

+

Re-compile mplayer with debugging code enabled:

+

    ./configure --enable-debug
+    make

+and then run mplayer within gdb using: +

    gdb mplayer

-

In general:

+

You are now within gdb. Type:

+

    run -v [options-to-mplayer] filename

+and reproduce your crash. As soon as you did it, gdb will +return you to the command line prompt where you have to enter +

    bt
+    disass $eip-32 $eip+32

+and send the complete output to us. -

If something is big (logs etc) then it's better to upload to the ftp -(gzipped), and include only path/filename in the bugreport!

+

General note

-

I know what am I doing...

+

If something is quite big (logs for instance) then it is better to upload +it to the FTP-server in a compressed format (gzip and bzip preferred) and +include only the path and filename in your bug report.

-

If you created a proper bugreport following the above steps, and you are -sure it's mplayer bug, not compiler's problem or broken file, you've already -readed through docs and you didn't find the solution, your sound drivers are ok, -then you may want to subscribe to the mplayer-advusers list and send your -bugreport there to get better and faster answer. But BE WARNED: if you post -newbie or rtfm-type questions there, you'll be immediatelly banned, instead or -getting answered!!! So don't flame us, subscribe -advusers only if you really -know what are you doing and you feel you as advanced mplayer user or developer. -(and about how to subscribe: find it out! if you're really an advanced user, -it shouldn't be a problem for you...) +

I know what I am doing...

+ +

If you created a proper bug report following the steps above and you are +confident it is a bug in mplayer, not a compiler problem or broken file, +you have already read the documentation and you could not find a solution, +your sound drivers are OK, then you might want to subscribe to the +mplayer-advusers list and send your bug report there to get a better and +faster answer.

+Please be advised that if you post newbie questions or questions answered +in the manual there, you will be ignored or flamed instead of getting an +appropriate answer.
+So do not flame us and subscribe to -advusers only if you really know +what you are doing and feel like being an advanced mplayer user or +developer. If you meet these criteria it should not be difficult to find +out how to subscribe...