Unverified Commit f1b518b4 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Arnd Bergmann
Browse files

Documentation/process: maintainer-soc: add clean platforms profile



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: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: default avatarConor Dooley <conor.dooley@microchip.com>
Link: https://lore.kernel.org/r/20230723131924.78190-2-krzysztof.kozlowski@linaro.org


Signed-off-by: default avatarArnd Bergmann <arnd@arndb.de>
parent a34d8a4b
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -17,5 +17,6 @@ Contents:

   maintainer-netdev
   maintainer-soc
   maintainer-soc-clean-dts
   maintainer-tip
   maintainer-kvm-x86
+25 −0
Original line number Diff line number Diff line
.. 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.
+1 −1
Original line number Diff line number Diff line
@@ -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