Sending Patches VLC

2015-02-27T18:01:12Z

Ingve: Fix phrasing

== How to produce a patch for VLC ==

*Get a modern [[Git]] version, 1.7 or higher.
*Make your changes and commit them.
*Check your commit.
*Produce a patch according to [[Git#Submitting_patches_to_the_vlc-devel_or_x264-devel|the Git page]], but '''don't send it yet'''. Read the following before sending.

== Writing an appropriate description ==

*The patch email's subject '''should''' be prefixed by "'''[PATCH]'''".
*You '''should''' include a description that will be the commit log message of your patch.
*A more '''exhaustive explanation''' is also welcomed along with your patch. This could be the '''second paragraph''' of your commit log.

== Check List ==

When you send a patch make sure that:

*It mostly '''complies''' to the [[Code Conventions]].
*It has a proper license for modifications.
*Make sure that it does not add more failure to '''`make check`'''.
*Make sure that your patch is produced against the latest '''master branch''' and not 2.0-bugfix or 2.1-bugfix.
**Most of the time patches are against branch versions such as the 2.1.x series which is not a development version. If this is a bugfix, it may be backported to 2.1-bugfix, but it probably should go in master branch first. Translations are one exception to this rule.
*Make sure your patch doesn't introduce '''trailing spaces''' (''git show --color'' show them in red).
*Make sure your patch doesn't introduce '''tabs''' (tabs are OK in Makefiles though).
*Make sure '''your name is correctly set'''. That is, that you are using your fullname, which is correctly capitalized and so on.
**For example, if you are '''John Smith''' with an e-mail of '''johnsmith@acme.example''', you should set your "Git name" to '''John Smith <johnsmith@acme.example>''' - real full name - not "jsmith", "John S", "J. Smith", "johnnykool1234", "J.S." or any other permutation.
*Read your patch one more time using '''''git show''''', and check that it looks OK.

== Sending it to the vlc-devel list ==

'''Now''' you can send it to the [http://mailman.videolan.org/listinfo/vlc-devel vlc-devel] mailing list.

''Please'' subscribe to it before sending your patch; otherwise, it may not get through the list's spam filters. You will be able to unsubscribe later easily if needed.

''Try'' to avoid sending patches bigger than 100kB on the mailing list, if you can.

== Following your patch ==

You can check if your patch was received by the list at the [http://mailman.videolan.org/pipermail/vlc-devel/ list archive].

If the patch gets approved, then there will normally be a post to the vlc-devel list to say "patch applied". There will also be a post to the [http://mailman.videolan.org/pipermail/vlc-commits/ vlc-commits] list ([http://mailman.videolan.org/listinfo/vlc-commits subscribe here]).

== Getting your patch merged ==

* ''Don't hesitate'' to '''re-ask''' for review if after a week there are no replies or comments.
* If there are comments, '''please answer''' to those and eventually correct your patch if possible.
* Check regularly on the [http://patches.videolan.org/project/vlc-devel/list/ patches website].
That should ensure that your patch gets merged.

[[Category:Coding]]

Report bugs

2015-02-27T17:43:04Z

Ingve: Fix typo

__NOTOC__
{{Languages}}
{{howto|report a VLC bug}}

:''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 '''{{VLC:latest_version}}'''.

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.<br />
Read the [[Frequently Asked Questions|FAQ]] for details on how to delete your preferences. (Uninstalling VLC does not remove its old settings).

=== New Features ===
Some things are simply not yet supported by VLC. We have a [https://trac.videolan.org/vlc/query?action=view&type=enhancement&order=priority 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 [https://trac.videolan.org/vlc/newticket trac].

=== Closed bugs ===
Many bugs are already known. Sometimes they are already fixed for the next version of VLC.

Please [https://trac.videolan.org/vlc/ 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)''

=== Nightly builds ===
Before you file a new bug, please try a preview development build of our next version on our [http://nightlies.videolan.org '''nightly build'''] website. The bug may already be fixed in those builds.

== Still a bug? ==
So you still think you found a bug? Great!

=== Search ===
Search on this wiki and on the [http://forum.videolan.org forums] and see if someone else has asked a similar question or has seen a similar bug.

Ask about your problem in the [http://forum.videolan.org/ relevant forum] and make sure to include as much information as possible (see the pointers below). You can also describe your problem on the [http://www.videolan.org/support/lists.html 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 [https://trac.videolan.org/vlc/newticket 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:

# '''Email''' with a valid reply address, so we can get back to you with possible additional questions.
# Your '''operating system''' and the precise version (include the Linux distribution, or the version of Windows).
# 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.
# 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 [http://streams.videolan.org/upload/ samples server].

= 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 debug under Win32|Tutorial for GDB with Win32]]

If your bug is a crash, please try to reproduce and report using a [http://nightlies.videolan.org/build/win32/last/ -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
<pre>
./configure <options> > logfile.txt 2>&1
make 2>&1 > logfile.txt 2>&1
</pre>

* 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 [[User:J-b|Jean-Baptiste Kempf]] for this wiki.

Template:VLC:latest version

2015-02-27T17:41:59Z

Ingve: Update to latest version

2.2.0

VideoLAN Wiki - User contributions [en]

Sending Patches VLC

Report bugs

Template:VLC:latest version