Difference between revisions of "Development: How to submit patches"

From LinuxTVWiki
Jump to: navigation, search
m (minor changes)
(minor changes)
Line 1: Line 1:
 
=== Patch Preparation ===
 
=== Patch Preparation ===
  
Patches should be created against the V4L-DVB mercurial tree; see [[How to build from Mercurial]].
+
Patches should be created against the [http://linuxtv.org/hg/v4l-dvb master V4L-DVB mercurial tree]; for instructions on obtaining these sources, see [[How to build from Mercurial]].
  
 
For general references on how to develop a Linux kernel driver module, take a look at the [http://jungla.dit.upm.es/%7Ejmseyas/linux/kernel/hackers-docs.html Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel].
 
For general references on how to develop a Linux kernel driver module, take a look at the [http://jungla.dit.upm.es/%7Ejmseyas/linux/kernel/hackers-docs.html Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel].
  
Post your patches to the [mailto:majordomo@vger.kernel.org?body=subscribe%20linux-media linux-media] Mailing List for review and testing.  
+
Post your patches to the [mailto:majordomo@vger.kernel.org?body=subscribe%20linux-media linux-media mailing list] for review and testing. [http://vger.kernel.org/vger-lists.html#linux-media Subscription to the mailing list] is recommended, though it is not required.
  
 
Follow the guidelines in [[Development: Submitting Patches|Submitting Patches]] (cf. [http://linux.yyz.us/patch-format.html jgarzik's version]), including:
 
Follow the guidelines in [[Development: Submitting Patches|Submitting Patches]] (cf. [http://linux.yyz.us/patch-format.html jgarzik's version]), including:
 
:* Verify best-practice [[Development: Coding Style|kernel coding style]]
 
:* Verify best-practice [[Development: Coding Style|kernel coding style]]
 
:* Use [PATCH] in the subject line to get attention
 
:* Use [PATCH] in the subject line to get attention
:* Explain what the patch does and what hardware it applies to
+
:* Explain what the patch does and to what hardware it applies
:* Document your work where appropriate, in the form of patches to the Documentation/video4linux or Documentation/dvb files (which ever is appropriate)
+
:* Document your work where appropriate (i.e. in the form of patches to the Documentation/video4linux or Documentation/dvb files)  
 
:* Add a '''Signed-off-by: Your name <name@yoursite.com>''' as a [[Development: Submitting Patches#Developer.27s_Certificate_of_Origin_1.1|Developer's Certificate of Origin 1.1 ]]
 
:* Add a '''Signed-off-by: Your name <name@yoursite.com>''' as a [[Development: Submitting Patches#Developer.27s_Certificate_of_Origin_1.1|Developer's Certificate of Origin 1.1 ]]
 
:* Fix any problems and repeat until everyone is happy ;)
 
:* Fix any problems and repeat until everyone is happy ;)
:* Send the patch inline, not as an attachment
+
:* Send the patch inline, not as an attachment (unless asked to do so otherwise)
  
Hint: [[Development: Linux Kernel patch submittal checklist|There's a checklist for patch submission ]]
+
Hint: There is also a [[Development: Linux Kernel patch submittal checklist|checklist for patch submission]]  
  
Subscription to the [http://vger.kernel.org/vger-lists.html#linux-media linux-media mailing list] is recommended but not required.
+
When your patch is initially accepted, it will first be applied to the main V4L-DVB mercurial tree. Once tested and integrated, patches are merged into a git tree by the V4L-DVB maintainer and periodically pulled by Linus.
 
+
The patch will be applied to the main mercurial tree. Once tested and integrated, patches are merged into a git tree by the V4L-DVB maintainer and periodically pulled by Linus.
+
  
 
[[Category:Development]]
 
[[Category:Development]]

Revision as of 22:38, 17 January 2009

Patch Preparation

Patches should be created against the master V4L-DVB mercurial tree; for instructions on obtaining these sources, see How to build from Mercurial.

For general references on how to develop a Linux kernel driver module, take a look at the Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel.

Post your patches to the linux-media mailing list for review and testing. Subscription to the mailing list is recommended, though it is not required.

Follow the guidelines in Submitting Patches (cf. jgarzik's version), including:

  • Verify best-practice kernel coding style
  • Use [PATCH] in the subject line to get attention
  • Explain what the patch does and to what hardware it applies
  • Document your work where appropriate (i.e. in the form of patches to the Documentation/video4linux or Documentation/dvb files)
  • Add a Signed-off-by: Your name <name@yoursite.com> as a Developer's Certificate of Origin 1.1
  • Fix any problems and repeat until everyone is happy ;)
  • Send the patch inline, not as an attachment (unless asked to do so otherwise)

Hint: There is also a checklist for patch submission

When your patch is initially accepted, it will first be applied to the main V4L-DVB mercurial tree. Once tested and integrated, patches are merged into a git tree by the V4L-DVB maintainer and periodically pulled by Linus.