devicetree/bindings/submitting-patches.rst

1 .. SPDX-License-Identifier: GPL-2.0
4 Submitting devicetree (DT) binding patches
10   0) Normal patch submission rules from Documentation/process/submitting-patches.rst
13   1) The Documentation/ and include/dt-bindings/ portion of the patch should
14      be a separate patch. The preferred subject prefix for binding patches is::
16        "dt-bindings: <binding dir>: ..."
20      docs. Repeating "binding" again should also be avoided.
22   2) DT binding files are written in DT schema format using json-schema
23      vocabulary and YAML file format. The DT binding files must pass validation
28      See ../writing-schema.rst for more details about schema and tools setup.
30   3) DT binding files should be dual licensed. The preferred license tag is
31      (GPL-2.0-only OR BSD-2-Clause).
37      and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify
38      all of the DT maintainers.
41      the code implementing the binding.
44      previously documented in the corresponding DT binding text file
49      ("checkpatch: add DT compatible string documentation checks"). ]
54          - compatible: Must contain '"nvidia,<chip>-pcie",
55            "nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
62      string that is matched by the driver (as in the "nvidia,tegra20-pcie"
69   1) If you aren't comfortable reviewing a given binding, reply to it and ask
74      binding, and it hasn't received an Acked-by from the devicetree
80   3) For a series going though multiple trees, the binding patch should be
81      kept with the driver using the binding.