Skip to content

Commit b31cc6a

Browse files
krzkrobherring
authored andcommitted
docs: dt: submitting-patches: Document sending DTS patches
Document two rules already widely used and enforced by DT maintainers and SoC platform maintainers: 1. DTS patches should be placed at the end of driver patchset to indicate no dependencies of driver code on DTS. 2. DTS patches should be applied via SoC platform maintainers, because it is a driver-independent hardware description. However some driver maintainers are reluctant to pick up portions of patchsets and prefer to take entire set at once. For such cases, the DTS portion should be split into separate patchset, so it will not end up in the driver subsystem integration tree. Signed-off-by: Krzysztof Kozlowski <[email protected]> Reviewed-by: Laurent Pinchart <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Rob Herring (Arm) <[email protected]>
1 parent 2ac9556 commit b31cc6a

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

Documentation/devicetree/bindings/submitting-patches.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,22 @@ I. For patch submitters
5454
followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
5555
("checkpatch: add DT compatible string documentation checks"). ]
5656

57-
7) If a documented compatible string is not yet matched by the
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
59+
be placed at the end of patchset to indicate no dependency of drivers on
60+
the DTS. DTS will be anyway applied through separate tree or branch, so
61+
different order would indicate the serie is non-bisectable.
62+
63+
If a driver subsystem maintainer prefers to apply entire set, instead of
64+
their relevant portion of patchset, please split the DTS patches into
65+
separate patchset with a reference in changelog or cover letter to the
66+
bindings submission on the mailing list.
67+
68+
8) If a documented compatible string is not yet matched by the
5869
driver, the documentation should also include a compatible
5970
string that is matched by the driver.
6071

61-
8) Bindings are actively used by multiple projects other than the Linux
72+
9) Bindings are actively used by multiple projects other than the Linux
6273
Kernel, extra care and consideration may need to be taken when making changes
6374
to existing bindings.
6475

@@ -79,6 +90,10 @@ II. For kernel maintainers
7990
3) For a series going though multiple trees, the binding patch should be
8091
kept with the driver using the binding.
8192

93+
4) The DTS files should however never be applied via driver subsystem tree,
94+
but always via platform SoC trees on dedicated branches (see also
95+
Documentation/process/maintainer-soc.rst).
96+
8297
III. Notes
8398
==========
8499

0 commit comments

Comments
 (0)