mirror of
https://github.com/torvalds/linux.git
synced 2024-12-26 21:02:19 +00:00
ef0b97e3da
When posting a patch series that includes both code implementing a Device Tree binding and its associated documentation, the DT docs should come in the series before the implementation. This not only avoids checkpatch.pl to complain about undocumented bindings but also makes the review process easier. Document this convention since it may not be obvious. Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk> Acked-by: Mark Rutland <mark.rutland@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
42 lines
1.5 KiB
Plaintext
42 lines
1.5 KiB
Plaintext
|
|
Submitting devicetree (DT) binding patches
|
|
|
|
I. For patch submitters
|
|
|
|
0) Normal patch submission rules from Documentation/SubmittingPatches
|
|
applies.
|
|
|
|
1) The Documentation/ portion of the patch should be a separate patch.
|
|
|
|
2) Submit the entire series to the devicetree mailinglist at
|
|
|
|
devicetree@vger.kernel.org
|
|
|
|
3) The Documentation/ portion of the patch should come in the series before
|
|
the code implementing the binding.
|
|
|
|
II. For kernel maintainers
|
|
|
|
1) If you aren't comfortable reviewing a given binding, reply to it and ask
|
|
the devicetree maintainers for guidance. This will help them prioritize
|
|
which ones to review and which ones are ok to let go.
|
|
|
|
2) For driver (not subsystem) bindings: If you are comfortable with the
|
|
binding, and it hasn't received an Acked-by from the devicetree
|
|
maintainers after a few weeks, go ahead and take it.
|
|
|
|
Subsystem bindings (anything affecting more than a single device)
|
|
then getting a devicetree maintainer to review it is required.
|
|
|
|
3) For a series going though multiple trees, the binding patch should be
|
|
kept with the driver using the binding.
|
|
|
|
III. Notes
|
|
|
|
0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.
|
|
|
|
1) This document is intended as a general familiarization with the process as
|
|
decided at the 2013 Kernel Summit. When in doubt, the current word of the
|
|
devicetree maintainers overrules this document. In that situation, a patch
|
|
updating this document would be appreciated.
|