Development: How to submit patches

From LinuxTVWiki
Revision as of 00:43, 18 January 2009 by CityK (Talk | contribs)

Jump to: navigation, search

This article provides an overview for submitting patches against V4L-DVB kernel driver modules and/or documentation. For general references in regards as to how to develop support for a particular device or in writing a new device driver, see here.

Patch Preparation

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

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 <> as a Developer's Certificate of Origin 1.1
  • Send the patch inline, not as an attachment (unless asked to do so otherwise)

Hint: There is also a checklist for patch submission

After you've Submitted: What happens Next?

In the past, it was, unfortunately, not uncommon for patches to become overlooked or lost on the V4L-DVB mailing lists. However, with the new Linux-media mailing list, V4L-DVB is now using the Patchwork tool for aggregating patches sent into the list (you can read more about it here). So, provided you have correctly submitted your patch, the steps towards having your code adopted will have been put into motion.

The first thing you should expect is that a code review will be performed, and often this is by various parties. This may lead to a series of requests for you to fix any observed problems and require you to then resubmit your work, by repeating the steps outlined above, until everyone is happy with the submission. In other words: wash, rinse, repeat ;)

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