diff mbox series

[1/2] docs: dt: submitting-patches: drop outdated points to TXT format

Message ID 20240108083750.16350-1-krzysztof.kozlowski@linaro.org
State Accepted
Commit ed3648d264c7f95c7ae0a13d98da0da2018a5bbd
Headers show
Series [1/2] docs: dt: submitting-patches: drop outdated points to TXT format | expand

Commit Message

Krzysztof Kozlowski Jan. 8, 2024, 8:37 a.m. UTC
New bindings in TXT format are not accepted and DT schema format expects
all compatibles to be explicitly defined, thus guidance about "wildcard
<chip>" is not correct anymore.  Drop that paragraph and update one more
place which still mentions TXT files.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

Cc: Mark Brown <broonie@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
---
 .../devicetree/bindings/submitting-patches.rst | 18 ++++--------------
 1 file changed, 4 insertions(+), 14 deletions(-)

Comments

Rob Herring (Arm) Jan. 13, 2024, 1:58 a.m. UTC | #1
On Mon, 08 Jan 2024 09:37:49 +0100, Krzysztof Kozlowski wrote:
> New bindings in TXT format are not accepted and DT schema format expects
> all compatibles to be explicitly defined, thus guidance about "wildcard
> <chip>" is not correct anymore.  Drop that paragraph and update one more
> place which still mentions TXT files.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> 
> ---
> 
> Cc: Mark Brown <broonie@kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
>  .../devicetree/bindings/submitting-patches.rst | 18 ++++--------------
>  1 file changed, 4 insertions(+), 14 deletions(-)
> 

Applied, thanks!
Rob Herring (Arm) Jan. 13, 2024, 1:59 a.m. UTC | #2
On Mon, 08 Jan 2024 09:37:50 +0100, Krzysztof Kozlowski wrote:
> ASoC, media, regulators and SPI subsystems prefer commits starting with
> subsystem name (e.g. "spi: dt-bindings:"), so document this to avoid
> confusing contributors.
> 
> Cc: Mark Brown <broonie@kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> ---
>  Documentation/devicetree/bindings/submitting-patches.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index 36a17b250ccc..b460ebffee42 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -42,28 +42,18 @@  I. For patch submitters
      the code implementing the binding.
 
   6) Any compatible strings used in a chip or board DTS file must be
-     previously documented in the corresponding DT binding text file
+     previously documented in the corresponding DT binding 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"). ]
 
-  7) 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.
-
-  8) If a documented compatible string is not yet matched by the
+  7) 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).
+     string that is matched by the driver.
 
-  9) Bindings are actively used by multiple projects other than the Linux
+  8) Bindings are actively used by multiple projects other than the Linux
      Kernel, extra care and consideration may need to be taken when making changes
      to existing bindings.