Documentation/process: maintainer-soc: add clean platforms profile
authorKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Sun, 23 Jul 2023 13:19:23 +0000 (15:19 +0200)
committerArnd Bergmann <arnd@arndb.de>
Sat, 12 Aug 2023 12:04:51 +0000 (14:04 +0200)
Some SoC platforms require that commits must not bring any new
dtbs_check warnings.  Maintainers of such platforms usually have some
automation set, so any new warning will be spotted sooner or later.
Worst case: they run the tests themselves.  Document requirements for
such platforms, so contributors can expect their patches being dropped
or ignored, if they bring new warnings for existing boards.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
Link: https://lore.kernel.org/r/20230723131924.78190-2-krzysztof.kozlowski@linaro.org
Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Documentation/process/maintainer-handbooks.rst
Documentation/process/maintainer-soc-clean-dts.rst [new file with mode: 0644]
MAINTAINERS

index 9992bfd..976391c 100644 (file)
@@ -17,5 +17,6 @@ Contents:
 
    maintainer-netdev
    maintainer-soc
+   maintainer-soc-clean-dts
    maintainer-tip
    maintainer-kvm-x86
diff --git a/Documentation/process/maintainer-soc-clean-dts.rst b/Documentation/process/maintainer-soc-clean-dts.rst
new file mode 100644 (file)
index 0000000..1b32430
--- /dev/null
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============================================
+SoC Platforms with DTS Compliance Requirements
+==============================================
+
+Overview
+--------
+
+SoC platforms or subarchitectures should follow all the rules from
+Documentation/process/maintainer-soc.rst.  This document referenced in
+MAINTAINERS impose additional requirements listed below.
+
+Strict DTS DT Schema and dtc Compliance
+---------------------------------------
+
+No changes to the SoC platform Devicetree sources (DTS files) should introduce
+new ``make dtbs_check W=1`` warnings.  Warnings in a new board DTS, which are
+results of issues in an included DTSI file, are considered existing, not new
+warnings.  The platform maintainers have automation in place which should point
+out any new warnings.
+
+If a commit introducing new warnings gets accepted somehow, the resulting
+issues shall be fixed in reasonable time (e.g. within one release) or the
+commit reverted.
index 59f7275..b93e4de 100644 (file)
@@ -1561,7 +1561,7 @@ S:        Maintained
 P:     Documentation/process/maintainer-soc.rst
 C:     irc://irc.libera.chat/armlinux
 T:     git git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc.git
-F:     Documentation/process/maintainer-soc.rst
+F:     Documentation/process/maintainer-soc*.rst
 F:     arch/arm/boot/dts/Makefile
 F:     arch/arm64/boot/dts/Makefile