Difference between revisions of "Sending Patches VLC"
Jump to navigation
Jump to search
| Line 16: | Line 16: | ||
*It mostly '''complies''' to the [[Code Conventions]]. | *It mostly '''complies''' to the [[Code Conventions]]. | ||
| − | *It has a proper license for modifications | + | *It has a proper license for modifications. |
| − | |||
*Make sure that it does not add more failure to '''`make check`'''. | *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 1.1-bugfix or 2.0-bugfix | + | *Make sure that your patch is produced against the latest '''master branch''' and not 1.1-bugfix or 2.0-bugfix. |
| + | **Most of the time patches are against branch versions such as the 2.0.x series which is not a development version. If this is a bugfix, it may be backported to 2.0-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 '''trailing spaces''' (''git show --color'' show them in red). | ||
| + | *Make sure your patch doesn't introduce '''tabs'''. | ||
*Make sure '''your name is correctly set'''. That is, that you are using your fullname, which is correctly capitalized and so on. | *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. | **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. | *Read your patch one more time using '''''git show''''', and check that it looks OK. | ||
| − | |||
| − | |||
== Sending it to the vlc-devel == | == Sending it to the vlc-devel == | ||
Revision as of 09:46, 10 November 2012
Contents
How to produce a patch for VLC
- Get the latest Git revision.
- Make your changes and commit them.
- Produce a patch according to 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 1.1-bugfix or 2.0-bugfix.
- Most of the time patches are against branch versions such as the 2.0.x series which is not a development version. If this is a bugfix, it may be backported to 2.0-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.
- 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
Now you can send it to the vlc-devel.
Please subscribe to it before sending your patch, or else it may not got 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 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 vlc-commits list (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.
That should ensure that your patch gets merged.
