devicetree/bindings/submitting-patches.rst

1 .. SPDX-License-Identifier: GPL-2.0
4 Submitting Devicetree (DT) binding patches
11      Documentation/process/submitting-patches.rst applies.
13   1) The Documentation/ and include/dt-bindings/ portion of the patch should
16        "dt-bindings: <binding dir>: ..."
21        "<binding dir>: dt-bindings: ..."
24      use "Documentation" or "doc" because that is implied. All bindings are
27   2) DT binding files are written in DT schema format using json-schema
28      vocabulary and YAML file format. The DT binding files must pass validation
33      See Documentation/devicetree/bindings/writing-schema.rst for more details
36   3) DT binding files should be dual licensed. The preferred license tag is
37      (GPL-2.0-only OR BSD-2-Clause).
43      and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify
44      all of the DT maintainers.
50      previously documented in the corresponding DT binding file
51      in Documentation/devicetree/bindings.  This rule applies even if
55      ("checkpatch: add DT compatible string documentation checks"). ]
57   7) DTS is treated in general as driver-independent hardware description, thus
58      any DTS patches, regardless whether using existing or new bindings, should
61      different order would indicate the serie is non-bisectable.
66      bindings submission on the mailing list.
72   9) Bindings are actively used by multiple projects other than the Linux
74      to existing bindings.
83   2) For driver (not subsystem) bindings: If you are comfortable with the
84      binding, and it hasn't received an Acked-by from the devicetree
87      For subsystem bindings (anything affecting more than a single device),
95      Documentation/process/maintainer-soc.rst).
100   0) Please see Documentation/devicetree/bindings/ABI.rst for details