Mercurial > mplayer.hg
annotate DOCS/xml/en/bugreports.xml @ 14113:4c91818a371c
link updates
author | diego |
---|---|
date | Sun, 05 Dec 2004 23:54:49 +0000 |
parents | 845882906af0 |
children | b0dd473ed38a |
rev | line source |
---|---|
9675 | 1 <?xml version="1.0" encoding="iso-8859-1"?> |
10913
49b1a67e7381
Add revision keyword to english xml files, to ease translation synchronization
lumag
parents:
10111
diff
changeset
|
2 <!-- $Revision$ --> |
9675 | 3 <appendix id="bugreports"> |
4 <title>How to report bugs</title> | |
5 <para> | |
6 Good bug reports are a very valuable contribution to the development of any | |
7 software project. But just like writing good software, good problem reports | |
8 involve some work. Please realize that most developers are extremely busy and | |
9 receive obscene amounts of email. So while your feedback is crucial in improving | |
11540 | 10 <application>MPlayer</application> and very much appreciated, please understand |
11 that you have to provide <emphasis role="bold">all</emphasis> of the information | |
12 we request and follow the instructions in this document closely. | |
9675 | 13 </para> |
14 <sect1 id="bugreports_fix"> | |
15 <title>How to fix bugs</title> | |
16 <para> | |
17 If you feel have the necessary skills you are invited to have a go at fixing the | |
18 bug yourself. Or maybe you already did that? Please read | |
19 <ulink url="../../tech/patches.txt">this short document</ulink> to find out how to | |
11540 | 20 get your code included in <application>MPlayer</application>. The people on the |
9675 | 21 <ulink url="http://mplayerhq.hu/mailman/listinfo/mplayer-dev-eng">mplayer-dev-eng</ulink> |
22 mailing list will assist you if you have questions. | |
23 </para> | |
24 </sect1> | |
25 <sect1 id="bugreports_report"> | |
26 <title>How to report bugs</title> | |
27 <para> | |
11540 | 28 First of all please try the latest CVS version of <application>MPlayer</application> |
29 as your bug might already be fixed there. Development moves extremely fast, | |
30 most problems in official releases are reported within days or even hours, so | |
31 please use <emphasis role="bold">only CVS</emphasis> to report bugs. This | |
32 includes binary packages of <application>MPlayer</application>. CVS | |
33 instructions can be found at the bottom of | |
9675 | 34 <ulink url="http://www.mplayerhq.hu/homepage/dload.html">this page</ulink> or in |
35 the README. If this did not help please refer to the list of | |
36 <link linkend="bugs">known bugs</link> and the rest of the documentation. If your | |
37 problem is not known or not solvable by our instructions, then please report the bug. | |
38 </para> | |
39 | |
40 <para> | |
41 Please do not send bug reports privately to individual developers. This is | |
42 community work and thus there might be several people interested in it. Sometimes | |
43 other users already experienced your troubles and know how to circumvent a problem | |
11540 | 44 even if it is a bug in <application>MPlayer</application> code. |
9675 | 45 </para> |
46 | |
47 <para> | |
48 Please describe your problem in as much detail as possible. Do a little detective | |
49 work to narrow down the circumstances under which the problem occurs. Does the bug | |
50 only show up in certain situations? Is it specific to certain files or file types? | |
51 Does it occur with only one codec or is it codec independent? Can you reproduce it | |
52 with all output drivers? The more information you provide the better are our | |
53 chances at fixing your problem. Please do not forget to also include the valuable | |
54 information requested below, we will be unable to properly diagnose your problem | |
55 otherwise. | |
56 </para> | |
57 | |
58 <para> | |
59 An excellent and well written guide to asking questions in public forums is | |
9740 | 60 <ulink url="http://www.catb.org/~esr/faqs/smart-questions.html">How To Ask |
61 Questions The Smart Way</ulink> by <ulink url="http://www.catb.org/~esr/">Eric S. Raymond</ulink>. | |
9675 | 62 There is another called |
63 <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to Report | |
64 Bugs Effectively</ulink> by <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/">Simon Tatham</ulink>. | |
65 If you follow these guidelines you should be able to get help. But please | |
66 understand that we all follow the mailing lists voluntarily in our free time. We | |
67 are very busy and cannot guarantee that you will get a solution for your problem | |
68 or even an answer. | |
69 </para> | |
70 | |
71 </sect1> | |
72 | |
73 <sect1 id="bugreports_where"> | |
74 <title>Where to report bugs</title> | |
75 <para> | |
76 Subscribe to the mplayer-users mailing list: | |
77 <ulink url="http://mplayerhq.hu/mailman/listinfo/mplayer-users"/> | |
12622 | 78 and send your bug report to |
79 <ulink url="mailto:mplayer-users@mplayerhq.hu"/> where you can discuss it. | |
80 </para> | |
81 <para> | |
12695 | 82 If you prefer, you can use our brand-new |
12664 | 83 <ulink url="http://bugzilla.mplayerhq.hu/">Bugzilla</ulink> instead. |
9675 | 84 </para> |
85 <para> | |
10111 | 86 The language of this list is <emphasis role="bold">English</emphasis>. Please follow the standard |
9675 | 87 <ulink url="http://www.ietf.org/rfc/rfc1855.txt">Netiquette Guidelines</ulink> and |
10111 | 88 <emphasis role="bold">do not send HTML mail</emphasis> to any of our mailing lists. You will only get ignored or |
9675 | 89 banned. If you do not know what HTML mail is or why it is evil, read this |
90 <ulink url="http://expita.com/nomime.html">fine document</ulink>. It explains all | |
91 the details and has instructions for turning HTML off. Also note that we will not | |
92 individually CC (carbon-copy) people so it is a good idea to subscribe to actually | |
93 receive your answer. | |
94 </para> | |
95 </sect1> | |
96 | |
97 <sect1 id="bugreports_what"> | |
98 <title>What to report</title> | |
99 <para> | |
100 You may need to include log, configuration or sample files in your bug report. | |
101 If some of them are quite big then it is better to upload them to our | |
102 <ulink url="ftp://mplayerhq.hu/MPlayer/incoming/">FTP server</ulink> in a | |
103 compressed format (gzip and bzip2 preferred) and include only the path and file | |
104 name in your bug report. Our mailing lists have a message size limit of 80k, if | |
105 you have something bigger you have to compress or upload it. | |
106 </para> | |
107 | |
108 <sect2 id="bugreports_system"> | |
109 <title>System Information</title> | |
110 <para> | |
111 <itemizedlist> | |
112 <listitem><para> | |
113 Your Linux distribution or operating system and version e.g.: | |
114 <itemizedlist> | |
115 <listitem><para>Red Hat 7.1</para></listitem> | |
116 <listitem><para>Slackware 7.0 + devel packs from 7.1 ...</para></listitem> | |
117 </itemizedlist> | |
118 </para></listitem> | |
119 <listitem><para> | |
120 kernel version: | |
121 <screen>uname -a</screen> | |
122 </para></listitem> | |
123 <listitem><para> | |
124 libc version: | |
125 <screen>ls -l /lib/libc[.-]*</screen> | |
126 </para></listitem> | |
127 <listitem><para> | |
128 gcc and ld versions: | |
129 <screen> | |
130 gcc -v | |
131 ld -v | |
132 </screen> | |
133 </para></listitem> | |
134 <listitem><para> | |
10111 | 135 binutils version: |
136 <screen> | |
137 as --version | |
138 </screen> | |
139 </para></listitem> | |
140 <listitem><para> | |
9675 | 141 If you have problems with fullscreen mode: |
142 <itemizedlist> | |
143 <listitem><para>Window manager type and version</para></listitem> | |
144 </itemizedlist> | |
145 </para></listitem> | |
146 <listitem><para> | |
147 If you have problems with XVIDIX: | |
148 <itemizedlist> | |
149 <listitem><para>X colour depth: | |
150 <screen>xdpyinfo | grep "depth of root"</screen> | |
151 </para></listitem> | |
152 </itemizedlist> | |
153 </para></listitem> | |
154 <listitem><para> | |
155 If only the GUI is buggy: | |
156 <itemizedlist> | |
157 <listitem><para>GTK version</para></listitem> | |
158 <listitem><para>GLIB version</para></listitem> | |
159 <listitem><para>libpng version</para></listitem> | |
160 <listitem><para>GUI situation in which the bug occurs</para></listitem> | |
161 </itemizedlist> | |
162 </para></listitem> | |
163 </itemizedlist> | |
164 </para> | |
165 </sect2> | |
166 | |
167 <sect2 id="bugreports_hardware"> | |
168 <title>Hardware and drivers</title> | |
169 <para> | |
170 <itemizedlist> | |
171 <listitem><para> | |
172 CPU info (this works on Linux only): | |
173 <screen>cat /proc/cpuinfo</screen> | |
174 </para></listitem> | |
175 <listitem><para> | |
176 Video card manufacturer and model, e.g.: | |
177 <itemizedlist> | |
178 <listitem><para>ASUS V3800U chip: nVidia TNT2 Ultra pro 32MB SDRAM</para></listitem> | |
179 <listitem><para>Matrox G400 DH 32MB SGRAM</para></listitem> | |
180 </itemizedlist> | |
181 </para></listitem> | |
182 <listitem><para> | |
183 Video driver type & version, e.g.: | |
184 <itemizedlist> | |
185 <listitem><para>X built-in driver</para></listitem> | |
186 <listitem><para>nVidia 0.9.623</para></listitem> | |
187 <listitem><para>Utah-GLX CVS 2001-02-17</para></listitem> | |
188 <listitem><para>DRI from X 4.0.3</para></listitem> | |
189 </itemizedlist> | |
190 </para></listitem> | |
191 <listitem><para> | |
192 Sound card type & driver, e.g.: | |
193 <itemizedlist> | |
194 <listitem><para>Creative SBLive! Gold with OSS driver from oss.creative.com</para></listitem> | |
195 <listitem><para>Creative SB16 with kernel OSS drivers</para></listitem> | |
196 <listitem><para>GUS PnP with ALSA OSS emulation</para></listitem> | |
197 </itemizedlist> | |
198 </para></listitem> | |
199 <listitem><para> | |
200 If in doubt include <command>lspci -vv</command> output on Linux systems. | |
201 </para></listitem> | |
202 </itemizedlist> | |
203 </para> | |
204 </sect2> | |
205 | |
206 <sect2 id="bugreports_configure"> | |
207 <title>Configure problems</title> | |
208 <para> | |
209 If you get errors while running <command>./configure</command>, or autodetection | |
210 of something fails, read <filename>configure.log</filename>. You may find the | |
211 answer there, for example multiple versions of the same library mixed on your | |
212 system, or you forgot to install the development package (those with the -dev | |
213 suffix). If you think there is a bug, include <filename>configure.log</filename> | |
214 in your bug report. | |
215 </para> | |
216 </sect2> | |
217 | |
218 <sect2 id="bugreports_conpilation"> | |
219 <title>Compilation problems</title> | |
220 <para> | |
221 Please include these files: | |
222 <itemizedlist> | |
223 <listitem><para>config.h</para></listitem> | |
224 <listitem><para>config.mak</para></listitem> | |
225 </itemizedlist> | |
226 Only if compilation fails below one of these directories, include these files: | |
227 <itemizedlist> | |
228 <listitem><para>Gui/config.mak</para></listitem> | |
229 <listitem><para>libvo/config.mak</para></listitem> | |
230 <listitem><para>libao2/config.mak</para></listitem> | |
231 </itemizedlist> | |
232 </para> | |
233 </sect2> | |
234 | |
235 <sect2 id="bugreports_playback"> | |
236 <title>Playback problems</title> | |
237 <para> | |
238 Please include the output of <application>MPlayer</application> at verbosity level | |
239 1, but remember to <emphasis role="bold">not truncate the output</emphasis> when | |
240 you paste it into your mail. The developers need all of the messages to properly | |
241 diagnose a problem. You can direct the output into a file like this: | |
242 <screen>mplayer -v <replaceable>options</replaceable> <replaceable>filename</replaceable> > mplayer.log 2>&1</screen> | |
243 </para> | |
244 | |
245 <para> | |
246 If your problem is specific to one or more files, then please upload the offender(s) to: | |
247 <ulink url="ftp://mplayerhq.hu/MPlayer/incoming/"/> | |
248 </para> | |
249 | |
250 <para> | |
251 Also upload a small text file having the same base name as your file with a .txt | |
252 extension. Describe the problem you are having with the particular file there and | |
11540 | 253 include your email address as well as the output of <application>MPlayer</application> |
254 at verbosity level 1. Usually the first 1-5 MB of a file are enough to reproduce | |
255 the problem, but to be sure we ask you to: | |
9675 | 256 <screen>dd if=<replaceable>yourfile</replaceable> of=<replaceable>smallfile</replaceable> bs=1024k count=5</screen> |
257 It will take the first five megabytes of '<emphasis role="bold">your-file</emphasis>' | |
258 and write it to '<emphasis role="bold">small-file</emphasis>'. Then try again on | |
259 this small file and if the bug still shows up your sample is sufficient for us. | |
260 Please <emphasis role="bold">do not ever</emphasis> send such files via mail! | |
261 Upload it, and send only the path/filename of the file on the FTP-server. If the | |
262 file is accessible on the net, then sending the <emphasis role="bold">exact</emphasis> | |
263 URL is sufficient. | |
264 </para> | |
265 </sect2> | |
266 | |
267 <sect2 id="bugreports_crash"> | |
268 <title>Crashes</title> | |
269 <para> | |
270 You have to run <application>MPlayer</application> inside <command>gdb</command> | |
271 and send us the complete output or if you have a <filename>core</filename> dump of | |
272 the crash you can extract useful information from the Core file. Here's how: | |
273 </para> | |
274 | |
275 <sect3 id="bugreports_debug"> | |
276 <title>How to conserve information about a reproducible crash</title> | |
277 <para> | |
11540 | 278 Recompile <application>MPlayer</application> with debugging code enabled: |
9675 | 279 <screen> |
280 ./configure --enable-debug=3 | |
281 make | |
282 </screen> | |
11540 | 283 and then run <application>MPlayer</application> within gdb using: |
9675 | 284 <screen>gdb ./mplayer</screen> |
285 You are now within gdb. Type: | |
286 <screen>run -v <replaceable>options-to-mplayer</replaceable> <replaceable>filename</replaceable></screen> | |
287 and reproduce your crash. As soon as you did it, gdb will return you to the command | |
288 line prompt where you have to enter | |
289 <screen> | |
290 bt | |
291 disass $pc-32 $pc+32 | |
292 info all-registers | |
293 </screen> | |
294 </para> | |
295 </sect3> | |
296 | |
297 <sect3 id="bugreports_core"> | |
298 <title>How to extract meaningful information from a core dump</title> | |
299 <para> | |
11049 | 300 Create the following command file: |
9675 | 301 <screen> |
302 bt | |
303 disass $pc-32 $pc+32 | |
304 info all-registers | |
305 </screen> | |
11049 | 306 Then simply execute this command: |
9675 | 307 <screen>gdb mplayer --core=core -batch --command=<replaceable>command_file</replaceable> > mplayer.bug</screen> |
308 </para> | |
309 </sect3> | |
310 </sect2> | |
311 </sect1> | |
312 | |
313 <sect1 id="bugreports_advusers"> | |
314 <title>I know what I am doing...</title> | |
315 <para> | |
316 If you created a proper bug report following the steps above and you are confident | |
11540 | 317 it is a bug in <application>MPlayer</application>, not a compiler problem or broken |
318 file, you have already read the documentation and you could not find a solution, | |
319 your sound drivers are OK, then you might want to subscribe to the mplayer-advusers | |
320 list and send your bug report there to get a better and faster answer. | |
9675 | 321 </para> |
322 | |
323 <para> | |
324 Please be advised that if you post newbie questions or questions answered in the | |
325 manual there, you will be ignored or flamed instead of getting an appropriate answer. | |
326 So do not flame us and subscribe to -advusers only if you really know what you are | |
11540 | 327 doing and feel like being an advanced <application>MPlayer</application> user or |
328 developer. If you meet these criteria it should not be difficult to find out how to subscribe... | |
9675 | 329 </para> |
330 | |
331 </sect1> | |
332 | |
333 </appendix> |