Difference between revisions of "Report bugs"
| Line 66: | Line 66: | ||
# Your '''operating system''' and the precise version (include the Linux distribution, or the version of Windows). | # Your '''operating system''' and the precise version (include the Linux distribution, or the version of Windows). | ||
# Your {{VLC}} version. | # Your {{VLC}} version. | ||
| + | # The '''hardware''' you use. Make sure to name all the audio and video hardware in question that might be related to VLC's usage.<br />For instance: iMac G4 or Pentium4 with GeForce3, with an external USB dolby surround output device. | ||
# '''Complete logs''' as those from the messages dialog, '''verbosity to 2''' (GUI mode) or the -vvv switch (CLI mode) | # '''Complete logs''' as those from the messages dialog, '''verbosity to 2''' (GUI mode) or the -vvv switch (CLI mode) | ||
| − | # | + | # If the bug is a crash or lock-up/freeze, the '''complete''' threaded '''symbolic''' stack trace of VLC at the time (see also below). |
# The exact '''situation''' in which the problem occurred. Please describe in as much detail as possible. | # The exact '''situation''' in which the problem occurred. Please describe in as much detail as possible. | ||
# Can you always '''reproduce''' the problem in a certain way or only sometimes? | # Can you always '''reproduce''' the problem in a certain way or only sometimes? | ||
| Line 73: | Line 74: | ||
# If possible, the '''video sample''' in question:<br />If the issue is specific to a certain movie, it can help a lot if we have the movie itself. In this case please upload as much of the file as you can to our [http://streams.videolan.org/upload/ samples server]. | # If possible, the '''video sample''' in question:<br />If the issue is specific to a certain movie, it can help a lot if we have the movie itself. In this case please upload as much of the file as you can to our [http://streams.videolan.org/upload/ samples server]. | ||
# '''Email''' with a valid reply address, if you are not using trac, so we can get back to you with possible additional questions. | # '''Email''' with a valid reply address, if you are not using trac, so we can get back to you with possible additional questions. | ||
| + | |||
| + | Bugs with insufficient infos may be closed as incomplete (or invalid in the worst cases). VLC developers understand that you might not be able to provide all the required infos. However you need to understand that the VLC developers cannot resolve bugs without sufficient infos for analysis. | ||
= Filing a bug report = | = Filing a bug report = | ||
Revision as of 19:25, 8 June 2015
| This page describes how to report a VLC bug. | Other "how to" pages |
- Android users, please see Android Report bugs.
Reporting a VLC bug
If you find any bugs, or if you experience any crashes, then we would very much like to hear about the issue.
Here is some detailed information on how to submit useful bug reports. Please try to follow the bugs policy, so we all save time.
Is it truly a new bug?
It may sound strange, but many of the bug reports we get are not really bugs at all, or have been known for months, and/or are already fixed.
Please check the following:
Version
Are you using the latest version of VLC? The latest version is 3.0.12.
Bug reports on older versions of VLC are likely to be ignored, because changes in newer versions of VLC may have already fixed the issue.
Preferences
Have you tried resetting your preferences and restarting VLC yet?
Old preferences and/or incorrect settings are common causes of problems.
Read the FAQ for details on how to delete your preferences. (Uninstalling VLC does not remove its old settings).
Nightly builds
Before you file a new bug, please try a preview development build of our next version on our nightly build website. The bug may already be fixed in those builds.
New Features
Some things are simply not yet supported by VLC. We have a list of things we would like to implement in the future.
If your suggestion is not on this list, you might want to make a feature request bug on trac.
Closed bugs
Many bugs are already known. Sometimes they are already fixed for the next version of VLC, see the nightly builds section.
Please search the list of known and fixed issues. If you find your issue, see if it is already closed. The page of the issue will then show something like:
Ticket #87 (Closed: fixed)
Still a bug?
So you still think you found a bug? Great!
Search
Search on this wiki and on the forums and see if someone else has asked a similar question or has seen a similar bug.
Ask about your problem in the relevant forum and make sure to include as much information as possible (see the pointers below). You can also describe your problem on the relevant mailing list.
Enter the bug in trac
If you are sure that you found a bug and that you have all information needed, you can enter a bug in our Trac system.
You will need to register a user account before you can file a new bug (or comment on an existing one). Don't forget to enter a valid e-mail address if you want to receive notifications when your bug is handled.
Send a report
When you post on the forum, email us, or create a bug report, please provide as much information as possible in your report.
We try to answer all your mails, posts and reports, but there are so many that we simply do not have the time to do so for everyone.
The more sound and concrete details you provide about your issue, the better the chances that we will investigate it fully.
Information to send
Please gather the following information and send it along with your report:
- Your operating system and the precise version (include the Linux distribution, or the version of Windows).
- Your VLC media player version.
- The hardware you use. Make sure to name all the audio and video hardware in question that might be related to VLC's usage.
For instance: iMac G4 or Pentium4 with GeForce3, with an external USB dolby surround output device. - Complete logs as those from the messages dialog, verbosity to 2 (GUI mode) or the -vvv switch (CLI mode)
- If the bug is a crash or lock-up/freeze, the complete threaded symbolic stack trace of VLC at the time (see also below).
- The exact situation in which the problem occurred. Please describe in as much detail as possible.
- Can you always reproduce the problem in a certain way or only sometimes?
- The type and format of the movie you were playing. And whether or not the issue is present on other types of movies.
- If possible, the video sample in question:
If the issue is specific to a certain movie, it can help a lot if we have the movie itself. In this case please upload as much of the file as you can to our samples server. - Email with a valid reply address, if you are not using trac, so we can get back to you with possible additional questions.
Bugs with insufficient infos may be closed as incomplete (or invalid in the worst cases). VLC developers understand that you might not be able to provide all the required infos. However you need to understand that the VLC developers cannot resolve bugs without sufficient infos for analysis.
Filing a bug report
Bug severities
blocker: Impediment to software development, e.g. build breakage on most platforms, systematic crash at startup or when playing any file input.
critical: Impediment to software release, e.g. security issue, crash in most basic and common use cases (i.e. more than 50% of user base), crash at exit.
major: Basic feature not working, e.g. inputs other than file not working, file format or codec not rendered.
normal: Expert feature not working, e.g. stream output problem, specific configuration option. Feature requests.
minor: Problem that can be worked around easily or is really unimportant.
trivial: Typing error. Self-explanatory bugfixes. Inconsequential compiler warnings.
Bug priorities
If you have a high priority issue, you must provide a patch yourself, or arrange for someone to do so. The VideoLAN project and the VLC developers are not at your service (they do not get your money) and cannot satisfy all requests.
Keep in mind that abuse of "high" and "highest" priorities will only attract ill will.
Additional remarks
If you can, or if it applies to you try to take into account the following.
Windows users
You can send along the last VLC crash log. The file is called Crashdump. If you are familiar with gdb, you can use it to give us more detailed crash info. Tutorial for GDB with Win32
If your bug is a crash, please try to reproduce and report using a -debug build.
Mac OS X users
Please send along the last part of ~/Library/Logs/CrashReporter/VLC.crash.log if you can. Many crashes of VLC are logged in this file. You can open the file from VLC by going to the menu Window and choosing Messages. Now click the "Open CrashLog" button.
Please make sure you send the last crash (at the bottom of the file) and that it actually is the crash you described. The Date/Time field reports the time of the crash so that way you can check if it is the crash you experienced, or an earlier one.
Compile problems
Make sure you have read the Developers_Corner. Give the full log showing the problem
./configure <options> > logfile.txt 2>&1 make 2>&1 > logfile.txt 2>&1
- When dealing with a ./configure issue, please provide the generated config.log file.
- Your compiler brand and version may be relevant here as well.
Version
Written by Derk-Jan Hartman, for the VideoLAN Team.
Adapted by Jean-Baptiste Kempf for this wiki.
