submitting-patches.txt 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. Submitting devicetree (DT) binding patches
  2. I. For patch submitters
  3. 0) Normal patch submission rules from Documentation/SubmittingPatches
  4. applies.
  5. 1) The Documentation/ portion of the patch should be a separate patch.
  6. 2) Submit the entire series to the devicetree mailinglist at
  7. devicetree@vger.kernel.org
  8. and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify
  9. all of the DT maintainers.
  10. 3) The Documentation/ portion of the patch should come in the series before
  11. the code implementing the binding.
  12. 4) Any compatible strings used in a chip or board DTS file must be
  13. previously documented in the corresponding DT binding text file
  14. in Documentation/devicetree/bindings. This rule applies even if
  15. the Linux device driver does not yet match on the compatible
  16. string. [ checkpatch will emit warnings if this step is not
  17. followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
  18. ("checkpatch: add DT compatible string documentation checks"). ]
  19. 5) The wildcard "<chip>" may be used in compatible strings, as in
  20. the following example:
  21. - compatible: Must contain '"nvidia,<chip>-pcie",
  22. "nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
  23. As in the above example, the known values of "<chip>" should be
  24. documented if it is used.
  25. 6) If a documented compatible string is not yet matched by the
  26. driver, the documentation should also include a compatible
  27. string that is matched by the driver (as in the "nvidia,tegra20-pcie"
  28. example above).
  29. II. For kernel maintainers
  30. 1) If you aren't comfortable reviewing a given binding, reply to it and ask
  31. the devicetree maintainers for guidance. This will help them prioritize
  32. which ones to review and which ones are ok to let go.
  33. 2) For driver (not subsystem) bindings: If you are comfortable with the
  34. binding, and it hasn't received an Acked-by from the devicetree
  35. maintainers after a few weeks, go ahead and take it.
  36. Subsystem bindings (anything affecting more than a single device)
  37. then getting a devicetree maintainer to review it is required.
  38. 3) For a series going though multiple trees, the binding patch should be
  39. kept with the driver using the binding.
  40. III. Notes
  41. 0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.
  42. 1) This document is intended as a general familiarization with the process as
  43. decided at the 2013 Kernel Summit. When in doubt, the current word of the
  44. devicetree maintainers overrules this document. In that situation, a patch
  45. updating this document would be appreciated.