dt-bindings: submitting-patches: add guidance on patch content and subject

PATCH New Rob Herring 1 participant 1 message Jun 5, 2018 Device tree bindings

Share & tools

Rob Herring

author maintainer

2018-06-05 22:50 UTC #0 lore raw

PATCH 1/1 dt-bindings: submitting-patches: add guidance on patch content and subject

Clarify that binding patches should also include include/dt-bindings/* as part of them. The binding doc defines the ABI and the includes are part of that. Add some details on the preferred subject prefix and contents.

Signed-off-by Rob Herring <[email protected]>

---
 Documentation/devicetree/bindings/submitting-patches.txt | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Documentation/devicetree/bindings/submitting-patches.txt +8 -1

index 274058c583dd..de0d6090c0fd 100644
@@ -6,7 +6,14 @@ I. For patch submitters
   0) Normal patch submission rules from Documentation/process/submitting-patches.rst
      applies.
 
-  1) The Documentation/ portion of the patch should be a separate patch.
+  1) The Documentation/ and include/dt-bindings/ portion of the patch should
+     be a separate patch. The preferred subject prefix for binding patches is:
+
+       "dt-bindings: <binding dir>: ..."
+
+     The 80 characters of the subject are precious. It is recommended to not
+     use "Documentation" or "doc" because that is implied. All bindings are
+     docs. Repeating "binding" again should also be avoided.
 
   2) Submit the entire series to the devicetree mailinglist at

Signature · 1 line

2.17.0