Link to the GPL licence
[vlc.git] / doc / bugreport-howto.txt
1
2   Bug report  HOWTO
3  - - - - - - - - - -
4
5  * General rules
6
7    - Be sure the problem you are reporting is not already known, or
8   maybe even already solved. Source of information include the BUGS
9   file, the mailing-list archives at http://www.via.ecp.fr/ml/videolan/
10   and your old friend Google.
11
12    - Be sure to be using a recent version. Bug reports against old
13   versions of vlc are likely to be ignored, because changes in the
14   program may make it impossible to reproduce the bug, or may even have
15   fixed it.
16
17    - Give as many details as possible about your problem! Better too
18   much than not enough.
19
20    - Don't forget to say which version of vlc you are using (0.2.91,
21   CVS snapshot from 21 Dec 2001, Debian packages 0.2.92-4). It is
22   important to tell us where you got the packages from (web site, CVS,
23   distribution).
24
25    - Also, your platform is very important. vlc runs on a lot of
26   different operating systems, so you should at least provide your
27   operating system name and version (Windows 98, Debian Linux woody,
28   BeOS, ...) and your CPU (Pentium 3, Sparc, PowerPC, ...).
29
30
31  * Reporting a ./configure or make issue
32
33    - Give the full log showing the problem:
34       ./configure <options> > logfile.txt 2>&1
35       make 2>&1 > logfile.txt 2>&1
36
37    - When dealing with a ./configure issue, please provide the generated
38   config.log file.
39
40    - Your compiler brand and version may be relevant here as well.
41
42
43  * Reporting a crash
44
45    - Try to reproduce the crash and to explain how you reproduced it.
46
47    - A gdb backtrace can be useful. For it to have any meaning, vlc
48   should have been compiled with debug symbols (add the --enable-debug
49   flag to ./configure)
50
51
52  * Where to send bug reports?
53
54    - The vlc-devel mailing-list is probably the best place to send your
55   bug report, just email it to <vlc-devel@videolan.org>. If you are
56   concerned by the size of the attached files, you can put them on a
57   website and post their address instead.
58