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