comparison DOCS/xml/en/bugreports.xml @ 21521:b210a229fbcb

General reformatting round: - fix some " -> &quot; - reindent with more consistency - visual markup of <sect?> tags - break overly long lines - add missing <replaceable> tags in examples - cola truck standing by
author torinthiel
date Fri, 08 Dec 2006 11:38:06 +0000
parents c0687e92d463
children f551403d82a9
comparison
equal deleted inserted replaced
21520:0977cf2eb136 21521:b210a229fbcb
1 <?xml version="1.0" encoding="utf-8"?> 1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- $Revision$ --> 2 <!-- $Revision$ -->
3 <appendix id="bugreports"> 3 <appendix id="bugreports">
4 <title>How to report bugs</title> 4 <title>How to report bugs</title>
5
5 <para> 6 <para>
6 Good bug reports are a very valuable contribution to the development of any 7 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 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 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 receive obscene amounts of email. So while your feedback is crucial in improving
10 <application>MPlayer</application> and very much appreciated, please understand 11 <application>MPlayer</application> and very much appreciated, please understand
11 that you have to provide <emphasis role="bold">all</emphasis> of the information 12 that you have to provide <emphasis role="bold">all</emphasis> of the information
12 we request and follow the instructions in this document closely. 13 we request and follow the instructions in this document closely.
13 </para> 14 </para>
15
16
17 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
18
19
14 <sect1 id="bugreports_security"> 20 <sect1 id="bugreports_security">
15 <title>Report security releated bugs</title> 21 <title>Report security releated bugs</title>
22
16 <para> 23 <para>
17 In case you have found an exploitable bug and you would like to do the 24 In case you have found an exploitable bug and you would like to do the
18 right thing and let us fix it before you disclose it, we would be happy 25 right thing and let us fix it before you disclose it, we would be happy
19 to get your security advisory at 26 to get your security advisory at
20 <ulink url="mailto:&#115;&#101;&#99;&#117;&#114;&#105;&#116;&#121;&#64;&#109;&#112;&#108;&#97;&#121;&#101;&#114;&#104;&#113;&#46;&#104;&#117;">&#115;&#101;&#99;&#117;&#114;&#105;&#116;&#121;&#64;&#109;&#112;&#108;&#97;&#121;&#101;&#114;&#104;&#113;&#46;&#104;&#117;</ulink>. 27 <ulink url="mailto:&#115;&#101;&#99;&#117;&#114;&#105;&#116;&#121;&#64;&#109;&#112;&#108;&#97;&#121;&#101;&#114;&#104;&#113;&#46;&#104;&#117;">&#115;&#101;&#99;&#117;&#114;&#105;&#116;&#121;&#64;&#109;&#112;&#108;&#97;&#121;&#101;&#114;&#104;&#113;&#46;&#104;&#117;</ulink>.
23 Sending a fix is highly appreciated. 30 Sending a fix is highly appreciated.
24 Please don't delay your report to write proof-of-concept exploit, you can 31 Please don't delay your report to write proof-of-concept exploit, you can
25 send that one with another mail. 32 send that one with another mail.
26 </para> 33 </para>
27 </sect1> 34 </sect1>
35
36
37 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
38
39
28 <sect1 id="bugreports_fix"> 40 <sect1 id="bugreports_fix">
29 <title>How to fix bugs</title> 41 <title>How to fix bugs</title>
42
30 <para> 43 <para>
31 If you feel have the necessary skills you are invited to have a go at fixing the 44 If you feel have the necessary skills you are invited to have a go at fixing the
32 bug yourself. Or maybe you already did that? Please read 45 bug yourself. Or maybe you already did that? Please read
33 <ulink url="../../tech/patches.txt">this short document</ulink> to find out how to 46 <ulink url="../../tech/patches.txt">this short document</ulink> to find out how
34 get your code included in <application>MPlayer</application>. The people on the 47 to get your code included in <application>MPlayer</application>. The people on
48 the
35 <ulink url="http://lists.mplayerhq.hu/mailman/listinfo/mplayer-dev-eng">MPlayer-dev-eng</ulink> 49 <ulink url="http://lists.mplayerhq.hu/mailman/listinfo/mplayer-dev-eng">MPlayer-dev-eng</ulink>
36 mailing list will assist you if you have questions. 50 mailing list will assist you if you have questions.
37 </para> 51 </para>
38 </sect1> 52 </sect1>
53
54
55 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
56
57
39 <sect1 id="bugreports_regression_test"> 58 <sect1 id="bugreports_regression_test">
40 <title>How to do regression testing using Subversion</title> 59 <title>How to do regression testing using Subversion</title>
60
41 <para> 61 <para>
42 A problem that can happen sometimes is 'it used to work before, now it 62 A problem that can happen sometimes is 'it used to work before, now it
43 doesn't anymore...'. 63 doesn't anymore...'.
44 Here is a step by step procedure to try to pinpoint when the problem 64 Here is a step by step procedure to try to pinpoint when the problem
45 occurred. This is <emphasis role="bold">not</emphasis> for casual users. 65 occurred. This is <emphasis role="bold">not</emphasis> for casual users.
46 </para> 66 </para>
67
47 <para> 68 <para>
48 First, you'd need to fetch MPlayer's source tree from Subversion. 69 First, you'd need to fetch MPlayer's source tree from Subversion.
49 Instructions can be found at the bottom of 70 Instructions can be found at the bottom of
50 <ulink url="http://www.mplayerhq.hu/dload.html">this page</ulink>. 71 <ulink url="http://www.mplayerhq.hu/dload.html">this page</ulink>.
51 </para> 72 </para>
52 <para> 73
53 You will have now in the mplayer/ directory an image of the Subversion tree, on the 74 <para>
54 client side. 75 You will have now in the mplayer/ directory an image of the Subversion tree, on
76 the client side.
55 Now update this image to the date you want: 77 Now update this image to the date you want:
56 <screen> 78 <screen>
57 cd mplayer/ 79 cd mplayer/
58 svn update -r {"2004-08-23"} 80 svn update -r {"2004-08-23"}
59 </screen> 81 </screen>
60 The date format is YYYY-MM-DD HH:MM:SS. 82 The date format is YYYY-MM-DD HH:MM:SS.
61 Using this date format ensure that you will be able to extract patches 83 Using this date format ensure that you will be able to extract patches
62 according to the date at which they were committed, as in the 84 according to the date at which they were committed, as in the
63 <ulink url="http://lists.mplayerhq.hu/pipermail/mplayer-cvslog/">MPlayer-cvslog archive</ulink>. 85 <ulink url="http://lists.mplayerhq.hu/pipermail/mplayer-cvslog/">MPlayer-cvslog archive</ulink>.
64 </para> 86 </para>
87
65 <para> 88 <para>
66 Now proceed as for a normal update: 89 Now proceed as for a normal update:
67 <screen> 90 <screen>
68 ./configure 91 ./configure
69 make 92 make
70 </screen> 93 </screen>
71 </para> 94 </para>
95
72 <para> 96 <para>
73 If any non-programmer reads this, the fastest method to get at the point 97 If any non-programmer reads this, the fastest method to get at the point
74 where the problem occurred is to use a binary search &mdash; that is, 98 where the problem occurred is to use a binary search &mdash; that is,
75 search the date of the breakage by repeatedly dividing the search 99 search the date of the breakage by repeatedly dividing the search
76 interval in half. 100 interval in half.
77 For example, if the problem occurred in 2003, start at mid-year, then ask 101 For example, if the problem occurred in 2003, start at mid-year, then ask
78 "Is the problem already here?". 102 "Is the problem already here?".
79 If yes, go back to the first of April; if not, go to the first of October, 103 If yes, go back to the first of April; if not, go to the first of October,
80 and so on. 104 and so on.
81 </para> 105 </para>
106
82 <para> 107 <para>
83 If you have lot of free hard disk space (a full compile currently takes 108 If you have lot of free hard disk space (a full compile currently takes
84 100 MB, and around 300-350 MB if debugging symbols are enabled), copy the 109 100 MB, and around 300-350 MB if debugging symbols are enabled), copy the
85 oldest known working version before updating it; this will save time if 110 oldest known working version before updating it; this will save time if
86 you need to go back. 111 you need to go back.
87 (It is usually necessary to run 'make distclean' before recompiling an 112 (It is usually necessary to run 'make distclean' before recompiling an
88 earlier version, so if you do not make a backup copy of your original 113 earlier version, so if you do not make a backup copy of your original
89 source tree, you will have to recompile everything in it when you come 114 source tree, you will have to recompile everything in it when you come
90 back to the present.) 115 back to the present.)
91 </para> 116 </para>
117
92 <para> 118 <para>
93 When you have found the day where the problem happened, continue the search 119 When you have found the day where the problem happened, continue the search
94 using the mplayer-cvslog archive (sorted by date) and a more precise svn 120 using the mplayer-cvslog archive (sorted by date) and a more precise svn
95 update including hour, minute and second: 121 update including hour, minute and second:
96 <screen> 122 <screen>
97 svn update -r {"2004-08-23 15:17:25"} 123 svn update -r {"2004-08-23 15:17:25"}
98 </screen> 124 </screen>
99 This will allow you to easily find the exact patch that did it. 125 This will allow you to easily find the exact patch that did it.
100 </para> 126 </para>
127
101 <para> 128 <para>
102 If you find the patch that is the cause of the problem, you have almost won; 129 If you find the patch that is the cause of the problem, you have almost won;
103 report about it to the 130 report about it to the
104 <ulink url="http://bugzilla.mplayerhq.hu/">MPlayer Bugzilla</ulink> or 131 <ulink url="http://bugzilla.mplayerhq.hu/">MPlayer Bugzilla</ulink> or
105 subscribe to 132 subscribe to
108 There is a chance that the author will jump in to suggest a fix. 135 There is a chance that the author will jump in to suggest a fix.
109 You may also look hard at the patch until it is coerced to reveal where 136 You may also look hard at the patch until it is coerced to reveal where
110 the bug is :-). 137 the bug is :-).
111 </para> 138 </para>
112 </sect1> 139 </sect1>
140
141
142 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
143
144
113 <sect1 id="bugreports_report"> 145 <sect1 id="bugreports_report">
114 <title>How to report bugs</title> 146 <title>How to report bugs</title>
115 <para> 147
116 First of all please try the latest Subversion version of <application>MPlayer</application> 148 <para>
149 First of all please try the latest Subversion version of
150 <application>MPlayer</application>
117 as your bug might already be fixed there. Development moves extremely fast, 151 as your bug might already be fixed there. Development moves extremely fast,
118 most problems in official releases are reported within days or even hours, so 152 most problems in official releases are reported within days or even hours,
119 please use <emphasis role="bold">only Subversion</emphasis> to report bugs. This 153 so please use <emphasis role="bold">only Subversion</emphasis> to report bugs.
120 includes binary packages of <application>MPlayer</application>. Subversion 154 This includes binary packages of <application>MPlayer</application>.
121 instructions can be found at the bottom of 155 Subversion instructions can be found at the bottom of
122 <ulink url="http://www.mplayerhq.hu/dload.html">this page</ulink> or in 156 <ulink url="http://www.mplayerhq.hu/dload.html">this page</ulink> or in
123 the README. If this did not help please refer to the list of 157 the README. If this did not help please refer to the list of
124 <link linkend="bugs">known bugs</link> and the rest of the documentation. If your 158 <link linkend="bugs">known bugs</link> and the rest of the documentation.
125 problem is not known or not solvable by our instructions, then please report the bug. 159 If your problem is not known or not solvable by our instructions,
160 then please report the bug.
126 </para> 161 </para>
127 162
128 <para> 163 <para>
129 Please do not send bug reports privately to individual developers. This is 164 Please do not send bug reports privately to individual developers. This is
130 community work and thus there might be several people interested in it. Sometimes 165 community work and thus there might be several people interested in it.
131 other users already experienced your troubles and know how to circumvent a problem 166 Sometimes other users already experienced your troubles and know how to
132 even if it is a bug in <application>MPlayer</application> code. 167 circumvent a problem even if it is a bug in <application>MPlayer</application>
133 </para> 168 code.
134 169 </para>
135 <para> 170
136 Please describe your problem in as much detail as possible. Do a little detective 171 <para>
137 work to narrow down the circumstances under which the problem occurs. Does the bug 172 Please describe your problem in as much detail as possible. Do a little
138 only show up in certain situations? Is it specific to certain files or file types? 173 detective work to narrow down the circumstances under which the problem occurs.
139 Does it occur with only one codec or is it codec independent? Can you reproduce it 174 Does the bug only show up in certain situations? Is it specific to certain
140 with all output drivers? The more information you provide the better are our 175 files or file types? Does it occur with only one codec or is it codec
141 chances at fixing your problem. Please do not forget to also include the valuable 176 independent? Can you reproduce it with all output drivers? The more information
142 information requested below, we will be unable to properly diagnose your problem 177 you provide the better are our chances at fixing your problem. Please do not
143 otherwise. 178 forget to also include the valuable information requested below, we will be
179 unable to properly diagnose your problem otherwise.
144 </para> 180 </para>
145 181
146 <para> 182 <para>
147 An excellent and well written guide to asking questions in public forums is 183 An excellent and well written guide to asking questions in public forums is
148 <ulink url="http://www.catb.org/~esr/faqs/smart-questions.html">How To Ask 184 <ulink url="http://www.catb.org/~esr/faqs/smart-questions.html">How To Ask Questions The Smart Way</ulink>
149 Questions The Smart Way</ulink> by <ulink url="http://www.catb.org/~esr/">Eric S. Raymond</ulink>. 185 by <ulink url="http://www.catb.org/~esr/">Eric S. Raymond</ulink>.
150 There is another called 186 There is another called
151 <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to Report 187 <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to Report Bugs Effectively</ulink>
152 Bugs Effectively</ulink> by <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/">Simon Tatham</ulink>. 188 by <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/">Simon Tatham</ulink>.
153 If you follow these guidelines you should be able to get help. But please 189 If you follow these guidelines you should be able to get help. But please
154 understand that we all follow the mailing lists voluntarily in our free time. We 190 understand that we all follow the mailing lists voluntarily in our free time. We
155 are very busy and cannot guarantee that you will get a solution for your problem 191 are very busy and cannot guarantee that you will get a solution for your problem
156 or even an answer. 192 or even an answer.
157 </para> 193 </para>
158 194 </sect1>
159 </sect1> 195
196
197 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
198
160 199
161 <sect1 id="bugreports_where"> 200 <sect1 id="bugreports_where">
162 <title>Where to report bugs</title> 201 <title>Where to report bugs</title>
202
163 <para> 203 <para>
164 Subscribe to the MPlayer-users mailing list: 204 Subscribe to the MPlayer-users mailing list:
165 <ulink url="http://lists.mplayerhq.hu/mailman/listinfo/mplayer-users"/> 205 <ulink url="http://lists.mplayerhq.hu/mailman/listinfo/mplayer-users"/>
166 and send your bug report to 206 and send your bug report to
167 <ulink url="mailto:mplayer-users@mplayerhq.hu"/> where you can discuss it. 207 <ulink url="mailto:mplayer-users@mplayerhq.hu"/> where you can discuss it.
168 </para> 208 </para>
209
169 <para> 210 <para>
170 If you prefer, you can use our brand-new 211 If you prefer, you can use our brand-new
171 <ulink url="http://bugzilla.mplayerhq.hu/">Bugzilla</ulink> instead. 212 <ulink url="http://bugzilla.mplayerhq.hu/">Bugzilla</ulink> instead.
172 </para> 213 </para>
173 <para> 214
174 The language of this list is <emphasis role="bold">English</emphasis>. Please follow the standard 215 <para>
175 <ulink url="http://www.ietf.org/rfc/rfc1855.txt">Netiquette Guidelines</ulink> and 216 The language of this list is <emphasis role="bold">English</emphasis>.
176 <emphasis role="bold">do not send HTML mail</emphasis> to any of our mailing lists. You will only get ignored or 217 Please follow the standard
218 <ulink url="http://www.ietf.org/rfc/rfc1855.txt">Netiquette Guidelines</ulink>
219 and <emphasis role="bold">do not send HTML mail</emphasis> to any of our
220 mailing lists. You will only get ignored or
177 banned. If you do not know what HTML mail is or why it is evil, read this 221 banned. If you do not know what HTML mail is or why it is evil, read this
178 <ulink url="http://expita.com/nomime.html">fine document</ulink>. It explains all 222 <ulink url="http://expita.com/nomime.html">fine document</ulink>.
179 the details and has instructions for turning HTML off. Also note that we will not 223 It explains all the details and has instructions for turning HTML off. Also
180 individually CC (carbon-copy) people so it is a good idea to subscribe to actually 224 note that we will not individually CC (carbon-copy) people so it is a good idea
181 receive your answer. 225 to subscribe to actually receive your answer.
182 </para> 226 </para>
183 </sect1> 227 </sect1>
228
229
230 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
231
184 232
185 <sect1 id="bugreports_what"> 233 <sect1 id="bugreports_what">
186 <title>What to report</title> 234 <title>What to report</title>
235
187 <para> 236 <para>
188 You may need to include log, configuration or sample files in your bug report. 237 You may need to include log, configuration or sample files in your bug report.
189 If some of them are quite big then it is better to upload them to our 238 If some of them are quite big then it is better to upload them to our
190 <ulink url="ftp://upload.mplayerhq.hu/MPlayer/incoming/">FTP server</ulink> in a 239 <ulink url="ftp://upload.mplayerhq.hu/MPlayer/incoming/">FTP server</ulink> in a
191 compressed format (gzip and bzip2 preferred) and include only the path and file 240 compressed format (gzip and bzip2 preferred) and include only the path and file
192 name in your bug report. Our mailing lists have a message size limit of 80k, if 241 name in your bug report. Our mailing lists have a message size limit of 80k, if
193 you have something bigger you have to compress or upload it. 242 you have something bigger you have to compress or upload it.
194 </para> 243 </para>
195 244
245 <!-- ********** -->
246
196 <sect2 id="bugreports_system"> 247 <sect2 id="bugreports_system">
197 <title>System Information</title> 248 <title>System Information</title>
249
198 <para> 250 <para>
199 <itemizedlist> 251 <itemizedlist>
200 <listitem><para> 252 <listitem><para>
201 Your Linux distribution or operating system and version e.g.: 253 Your Linux distribution or operating system and version e.g.:
202 <itemizedlist> 254 <itemizedlist>
203 <listitem><para>Red Hat 7.1</para></listitem> 255 <listitem><para>Red Hat 7.1</para></listitem>
204 <listitem><para>Slackware 7.0 + devel packs from 7.1 ...</para></listitem> 256 <listitem><para>Slackware 7.0 + devel packs from 7.1 ...</para></listitem>
205 </itemizedlist> 257 </itemizedlist>
206 </para></listitem> 258 </para></listitem>
207 <listitem><para> 259 <listitem><para>
208 kernel version: 260 kernel version:
209 <screen>uname -a</screen> 261 <screen>uname -a</screen>
210 </para></listitem> 262 </para></listitem>
211 <listitem><para> 263 <listitem><para>
212 libc version: 264 libc version:
213 <screen>ls -l /lib/libc[.-]*</screen> 265 <screen>ls -l /lib/libc[.-]*</screen>
214 </para></listitem> 266 </para></listitem>
215 <listitem><para> 267 <listitem><para>
216 gcc and ld versions: 268 gcc and ld versions:
217 <screen> 269 <screen>
218 gcc -v 270 gcc -v
219 ld -v 271 ld -v<!--
220 </screen> 272 --></screen>
221 </para></listitem> 273 </para></listitem>
222 <listitem><para> 274 <listitem><para>
223 binutils version: 275 binutils version:
224 <screen> 276 <screen>as --version</screen>
225 as --version 277 </para></listitem>
226 </screen> 278 <listitem><para>
227 </para></listitem> 279 If you have problems with fullscreen mode:
228 <listitem><para>
229 If you have problems with fullscreen mode:
230 <itemizedlist> 280 <itemizedlist>
231 <listitem><para>Window manager type and version</para></listitem> 281 <listitem><para>Window manager type and version</para></listitem>
232 </itemizedlist> 282 </itemizedlist>
233 </para></listitem> 283 </para></listitem>
234 <listitem><para> 284 <listitem><para>
235 If you have problems with XVIDIX: 285 If you have problems with XVIDIX:
236 <itemizedlist> 286 <itemizedlist>
237 <listitem><para>X colour depth: 287 <listitem><para>
238 <screen>xdpyinfo | grep &quot;depth of root&quot;</screen> 288 X colour depth:
239 </para></listitem> 289 <screen>xdpyinfo | grep &quot;depth of root&quot;</screen>
240 </itemizedlist> 290 </para></listitem>
241 </para></listitem> 291 </itemizedlist>
242 <listitem><para> 292 </para></listitem>
243 If only the GUI is buggy: 293 <listitem><para>
294 If only the GUI is buggy:
244 <itemizedlist> 295 <itemizedlist>
245 <listitem><para>GTK version</para></listitem> 296 <listitem><para>GTK version</para></listitem>
246 <listitem><para>GLIB version</para></listitem> 297 <listitem><para>GLIB version</para></listitem>
247 <listitem><para>libpng version</para></listitem> 298 <listitem><para>libpng version</para></listitem>
248 <listitem><para>GUI situation in which the bug occurs</para></listitem> 299 <listitem><para>GUI situation in which the bug occurs</para></listitem>
250 </para></listitem> 301 </para></listitem>
251 </itemizedlist> 302 </itemizedlist>
252 </para> 303 </para>
253 </sect2> 304 </sect2>
254 305
306 <!-- ********** -->
307
255 <sect2 id="bugreports_hardware"> 308 <sect2 id="bugreports_hardware">
256 <title>Hardware and drivers</title> 309 <title>Hardware and drivers</title>
310
257 <para> 311 <para>
258 <itemizedlist> 312 <itemizedlist>
259 <listitem><para> 313 <listitem><para>
260 CPU info (this works on Linux only): 314 CPU info (this works on Linux only):
261 <screen>cat /proc/cpuinfo</screen> 315 <screen>cat /proc/cpuinfo</screen>
262 </para></listitem> 316 </para></listitem>
263 <listitem><para> 317 <listitem><para>
264 Video card manufacturer and model, e.g.: 318 Video card manufacturer and model, e.g.:
265 <itemizedlist> 319 <itemizedlist>
266 <listitem><para>ASUS V3800U chip: nVidia TNT2 Ultra pro 32MB SDRAM</para></listitem> 320 <listitem><para>ASUS V3800U chip: nVidia TNT2 Ultra pro 32MB SDRAM</para></listitem>
267 <listitem><para>Matrox G400 DH 32MB SGRAM</para></listitem> 321 <listitem><para>Matrox G400 DH 32MB SGRAM</para></listitem>
268 </itemizedlist> 322 </itemizedlist>
269 </para></listitem> 323 </para></listitem>
270 <listitem><para> 324 <listitem><para>
271 Video driver type &amp; version, e.g.: 325 Video driver type &amp; version, e.g.:
272 <itemizedlist> 326 <itemizedlist>
273 <listitem><para>X built-in driver</para></listitem> 327 <listitem><para>X built-in driver</para></listitem>
274 <listitem><para>nVidia 0.9.623</para></listitem> 328 <listitem><para>nVidia 0.9.623</para></listitem>
275 <listitem><para>Utah-GLX CVS 2001-02-17</para></listitem> 329 <listitem><para>Utah-GLX CVS 2001-02-17</para></listitem>
276 <listitem><para>DRI from X 4.0.3</para></listitem> 330 <listitem><para>DRI from X 4.0.3</para></listitem>
277 </itemizedlist> 331 </itemizedlist>
278 </para></listitem> 332 </para></listitem>
279 <listitem><para> 333 <listitem><para>
280 Sound card type &amp; driver, e.g.: 334 Sound card type &amp; driver, e.g.:
281 <itemizedlist> 335 <itemizedlist>
282 <listitem><para>Creative SBLive! Gold with OSS driver from oss.creative.com</para></listitem> 336 <listitem><para>Creative SBLive! Gold with OSS driver from oss.creative.com</para></listitem>
283 <listitem><para>Creative SB16 with kernel OSS drivers</para></listitem> 337 <listitem><para>Creative SB16 with kernel OSS drivers</para></listitem>
284 <listitem><para>GUS PnP with ALSA OSS emulation</para></listitem> 338 <listitem><para>GUS PnP with ALSA OSS emulation</para></listitem>
285 </itemizedlist> 339 </itemizedlist>
286 </para></listitem> 340 </para></listitem>
287 <listitem><para> 341 <listitem><para>
288 If in doubt include <command>lspci -vv</command> output on Linux systems. 342 If in doubt include <command>lspci -vv</command> output on Linux systems.
289 </para></listitem> 343 </para></listitem>
290 </itemizedlist> 344 </itemizedlist>
291 </para> 345 </para>
292 </sect2> 346 </sect2>
347
348 <!-- ********** -->
293 349
294 <sect2 id="bugreports_configure"> 350 <sect2 id="bugreports_configure">
295 <title>Configure problems</title> 351 <title>Configure problems</title>
352
296 <para> 353 <para>
297 If you get errors while running <command>./configure</command>, or autodetection 354 If you get errors while running <command>./configure</command>, or autodetection
298 of something fails, read <filename>configure.log</filename>. You may find the 355 of something fails, read <filename>configure.log</filename>. You may find the
299 answer there, for example multiple versions of the same library mixed on your 356 answer there, for example multiple versions of the same library mixed on your
300 system, or you forgot to install the development package (those with the -dev 357 system, or you forgot to install the development package (those with the -dev
303 </para> 360 </para>
304 </sect2> 361 </sect2>
305 362
306 <sect2 id="bugreports_compilation"> 363 <sect2 id="bugreports_compilation">
307 <title>Compilation problems</title> 364 <title>Compilation problems</title>
365
308 <para> 366 <para>
309 Please include these files: 367 Please include these files:
310 <itemizedlist> 368 <itemizedlist>
311 <listitem><para>config.h</para></listitem> 369 <listitem><para>config.h</para></listitem>
312 <listitem><para>config.mak</para></listitem> 370 <listitem><para>config.mak</para></listitem>
313 </itemizedlist> 371 </itemizedlist>
314 </para> 372 </para>
315 </sect2> 373 </sect2>
374
375 <!-- ********** -->
316 376
317 <sect2 id="bugreports_playback"> 377 <sect2 id="bugreports_playback">
318 <title>Playback problems</title> 378 <title>Playback problems</title>
319 <para> 379
320 Please include the output of <application>MPlayer</application> at verbosity level 380 <para>
321 1, but remember to <emphasis role="bold">not truncate the output</emphasis> when 381 Please include the output of <application>MPlayer</application> at verbosity
382 level 1, but remember to
383 <emphasis role="bold">not truncate the output</emphasis> when
322 you paste it into your mail. The developers need all of the messages to properly 384 you paste it into your mail. The developers need all of the messages to properly
323 diagnose a problem. You can direct the output into a file like this: 385 diagnose a problem. You can direct the output into a file like this:
324 <screen>mplayer -v <replaceable>options</replaceable> <replaceable>filename</replaceable> &gt; mplayer.log 2&gt;&amp;1</screen> 386 <screen>
325 </para> 387 mplayer -v <replaceable>options</replaceable> <replaceable>filename</replaceable> &gt; mplayer.log 2&gt;&amp;1
326 388 </screen>
327 <para> 389 </para>
328 If your problem is specific to one or more files, then please upload the offender(s) to: 390
391 <para>
392 If your problem is specific to one or more files,
393 then please upload the offender(s) to:
329 <ulink url="ftp://upload.mplayerhq.hu/MPlayer/incoming/"/> 394 <ulink url="ftp://upload.mplayerhq.hu/MPlayer/incoming/"/>
330 </para> 395 </para>
331 396
332 <para> 397 <para>
333 Also upload a small text file having the same base name as your file with a .txt 398 Also upload a small text file having the same base name as your file with a .txt
334 extension. Describe the problem you are having with the particular file there and 399 extension. Describe the problem you are having with the particular file there
335 include your email address as well as the output of <application>MPlayer</application> 400 and include your email address as well as the output of
336 at verbosity level 1. Usually the first 1-5 MB of a file are enough to reproduce 401 <application>MPlayer</application> at verbosity level 1.
402 Usually the first 1-5 MB of a file are enough to reproduce
337 the problem, but to be sure we ask you to: 403 the problem, but to be sure we ask you to:
338 <screen>dd if=<replaceable>yourfile</replaceable> of=<replaceable>smallfile</replaceable> bs=1024k count=5</screen> 404 <screen>
339 It will take the first five megabytes of '<emphasis role="bold">your-file</emphasis>' 405 dd if=<replaceable>yourfile</replaceable> of=<replaceable>smallfile</replaceable> bs=1024k count=5
340 and write it to '<emphasis role="bold">small-file</emphasis>'. Then try again on 406 </screen>
407 It will take the first five megabytes of
408 '<emphasis role="bold">your-file</emphasis>' and write it to
409 '<emphasis role="bold">small-file</emphasis>'. Then try again on
341 this small file and if the bug still shows up your sample is sufficient for us. 410 this small file and if the bug still shows up your sample is sufficient for us.
342 Please <emphasis role="bold">do not ever</emphasis> send such files via mail! 411 Please <emphasis role="bold">do not ever</emphasis> send such files via mail!
343 Upload it, and send only the path/filename of the file on the FTP-server. If the 412 Upload it, and send only the path/filename of the file on the FTP-server. If the
344 file is accessible on the net, then sending the <emphasis role="bold">exact</emphasis> 413 file is accessible on the net, then sending the
345 URL is sufficient. 414 <emphasis role="bold">exact</emphasis> URL is sufficient.
346 </para> 415 </para>
347 </sect2> 416 </sect2>
417
418 <!-- ********** -->
348 419
349 <sect2 id="bugreports_crash"> 420 <sect2 id="bugreports_crash">
350 <title>Crashes</title> 421 <title>Crashes</title>
422
351 <para> 423 <para>
352 You have to run <application>MPlayer</application> inside <command>gdb</command> 424 You have to run <application>MPlayer</application> inside <command>gdb</command>
353 and send us the complete output or if you have a <filename>core</filename> dump of 425 and send us the complete output or if you have a <filename>core</filename> dump
354 the crash you can extract useful information from the Core file. Here's how: 426 of the crash you can extract useful information from the Core file. Here's how:
355 </para> 427 </para>
428
356 429
357 <sect3 id="bugreports_debug"> 430 <sect3 id="bugreports_debug">
358 <title>How to conserve information about a reproducible crash</title> 431 <title>How to conserve information about a reproducible crash</title>
432
359 <para> 433 <para>
360 Recompile <application>MPlayer</application> with debugging code enabled: 434 Recompile <application>MPlayer</application> with debugging code enabled:
361 <screen> 435 <screen>
362 ./configure --enable-debug=3 436 ./configure --enable-debug=3
363 make 437 make
364 </screen> 438 </screen>
365 and then run <application>MPlayer</application> within gdb using: 439 and then run <application>MPlayer</application> within gdb using:
366 <screen>gdb ./mplayer</screen> 440 <screen>gdb ./mplayer</screen>
367 You are now within gdb. Type: 441 You are now within gdb. Type:
368 <screen>run -v <replaceable>options-to-mplayer</replaceable> <replaceable>filename</replaceable></screen> 442 <screen>
369 and reproduce your crash. As soon as you did it, gdb will return you to the command 443 run -v <replaceable>options-to-mplayer</replaceable> <replaceable>filename</replaceable>
370 line prompt where you have to enter 444 </screen>
445 and reproduce your crash. As soon as you did it, gdb will return you to the
446 command line prompt where you have to enter
371 <screen> 447 <screen>
372 bt 448 bt
373 disass $pc-32 $pc+32 449 disass $pc-32 $pc+32
374 info all-registers 450 info all-registers
375 </screen> 451 </screen>
376 </para> 452 </para>
377 </sect3> 453 </sect3>
378 454
455
379 <sect3 id="bugreports_core"> 456 <sect3 id="bugreports_core">
380 <title>How to extract meaningful information from a core dump</title> 457 <title>How to extract meaningful information from a core dump</title>
458
381 <para> 459 <para>
382 Create the following command file: 460 Create the following command file:
383 <screen> 461 <screen>
384 bt 462 bt
385 disass $pc-32 $pc+32 463 disass $pc-32 $pc+32
386 info all-registers 464 info all-registers
387 </screen> 465 </screen>
388 Then simply execute this command: 466 Then simply execute this command:
389 <screen>gdb mplayer --core=core -batch --command=<replaceable>command_file</replaceable> &gt; mplayer.bug</screen> 467 <screen>
468 gdb mplayer --core=core -batch --command=command_file &gt; mplayer.bug
469 </screen>
390 </para> 470 </para>
391 </sect3> 471 </sect3>
392 </sect2> 472 </sect2>
393 </sect1> 473 </sect1>
394 474
475
476 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
477
478
395 <sect1 id="bugreports_advusers"> 479 <sect1 id="bugreports_advusers">
396 <title>I know what I am doing...</title> 480 <title>I know what I am doing...</title>
397 <para> 481
398 If you created a proper bug report following the steps above and you are confident 482 <para>
399 it is a bug in <application>MPlayer</application>, not a compiler problem or broken 483 If you created a proper bug report following the steps above and you are
400 file, you have already read the documentation and you could not find a solution, 484 confident it is a bug in <application>MPlayer</application>, not a compiler
401 your sound drivers are OK, then you might want to subscribe to the MPlayer-advusers 485 problem or broken file, you have already read the documentation and you could
402 list and send your bug report there to get a better and faster answer. 486 not find a solution, your sound drivers are OK, then you might want to
487 subscribe to the MPlayer-advusers list and send your bug report there to get
488 a better and faster answer.
403 </para> 489 </para>
404 490
405 <para> 491 <para>
406 Please be advised that if you post newbie questions or questions answered in the 492 Please be advised that if you post newbie questions or questions answered in the
407 manual there, you will be ignored or flamed instead of getting an appropriate answer. 493 manual there, you will be ignored or flamed instead of getting an appropriate
408 So do not flame us and subscribe to -advusers only if you really know what you are 494 answer. So do not flame us and subscribe to -advusers only if you really know
409 doing and feel like being an advanced <application>MPlayer</application> user or 495 what you are doing and feel like being an advanced
410 developer. If you meet these criteria it should not be difficult to find out how to subscribe... 496 <application>MPlayer</application> user or developer. If you meet these
411 </para> 497 criteria it should not be difficult to find out how to subscribe...
412 498 </para>
413 </sect1> 499 </sect1>
414 500
415 </appendix> 501 </appendix>