path: root/dts/Bindings/submitting-patches.txt
diff options
authorSascha Hauer <>2015-03-03 08:11:01 +0100
committerSascha Hauer <>2015-03-03 08:11:01 +0100
commiteaa819409db6ac80fbd7c3d36450b2d1bec93576 (patch)
tree6cd5e0c7f8abe121af237b701ee9e0e1b6f7e40d /dts/Bindings/submitting-patches.txt
parent0c9aadb6185e1d84746b632284bc89e4e4c80cd3 (diff)
dts: update to v4.0-rc1
Signed-off-by: Sascha Hauer <>
Diffstat (limited to 'dts/Bindings/submitting-patches.txt')
1 files changed, 23 insertions, 0 deletions
diff --git a/dts/Bindings/submitting-patches.txt b/dts/Bindings/submitting-patches.txt
index b7ba01a..56742bc 100644
--- a/dts/Bindings/submitting-patches.txt
+++ b/dts/Bindings/submitting-patches.txt
@@ -15,6 +15,29 @@ I. For patch submitters
3) The Documentation/ portion of the patch should come in the series before
the code implementing the binding.
+ 4) Any compatible strings used in a chip or board DTS file must be
+ previously documented in the corresponding DT binding text file
+ in Documentation/devicetree/bindings. This rule applies even if
+ the Linux device driver does not yet match on the compatible
+ string. [ checkpatch will emit warnings if this step is not
+ followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
+ ("checkpatch: add DT compatible string documentation checks"). ]
+ 5) The wildcard "<chip>" may be used in compatible strings, as in
+ the following example:
+ - compatible: Must contain '"nvidia,<chip>-pcie",
+ "nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
+ As in the above example, the known values of "<chip>" should be
+ documented if it is used.
+ 6) If a documented compatible string is not yet matched by the
+ driver, the documentation should also include a compatible
+ string that is matched by the driver (as in the "nvidia,tegra20-pcie"
+ example above).
II. For kernel maintainers
1) If you aren't comfortable reviewing a given binding, reply to it and ask