checkpatch - "DT binding docs and includes should be a separate patch"

Hi Joe.

The following warnings triggers on the patch below:

c55d0a554843 (HEAD -> drm-misc-next) dt-bindings: panel: Convert orisetech,otm8009a to json-schema -:15: WARNING:FILE_PATH_CHANGES: added, moved or deleted file(s), does MAINTAINERS need updating? #15:
deleted file mode 100644

-:18: WARNING:DT_SPLIT_BINDING_PATCH: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt

-:43: WARNING:DT_SPLIT_BINDING_PATCH: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt

total: 0 errors, 3 warnings, 0 checks, 53 lines checked

1)
yaml files include maintainer information in the file.
I dunno if this replaces/overrules MAINTAINERS - so first warning may be OK. Also because we delete a file it seems semi relevant.

2)
As the patch only touches files in Documentation/devicetree/bindings the warning about a separate patch seems wrong.

But the general feedback - in this very special case - is that checkpatch seems a bit too noisy.

If we as a bonus could get a warning when new yaml files do not use:
# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) That would be great.

It is recommended but not mandatory to use the combi license for new yaml files.

I did not try to dive into this myself - in the hope someone more versed in checkpatch internals (aka you) could improve it.

Sam

From c55d0a554843f2c4dfb44d0c8a99a1670c32c33d Mon Sep 17 00:00:00 2001
From: Benjamin Gaignard <[email protected]>
Date: Thu, 6 Feb 2020 14:33:44 +0100
Subject: [PATCH 3/3] dt-bindings: panel: Convert orisetech,otm8009a to
json-schema

Convert orisetech,otm8009a to json-schema.

Signed-off-by Benjamin Gaignard <[email protected]>

Reviewed-by Rob Herring <[email protected]>

Reviewed-by Philippe Cornu <[email protected]>

Signed-off-by Sam Ravnborg <[email protected]>

Link https://patchwork.freedesktop.org/patch/msgid/[email protected]

---
 .../display/panel/orisetech,otm8009a.txt      | 23 --------
 .../display/panel/orisetech,otm8009a.yaml     | 53 +++++++++++++++++++
 2 files changed, 53 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/display/panel/orisetech,otm8009a.txt
 create mode 100644 Documentation/devicetree/bindings/display/panel/orisetech,otm8009a.yaml

Documentation/devicetree/bindings/display/panel/orisetech,otm8009a.txt deleted +0 -23

deleted file mode 100644
index 203b03eefb68..000000000000
@@ -1,23 +0,0 @@
-Orise Tech OTM8009A 3.97" 480x800 TFT LCD panel (MIPI-DSI video mode)
-
-The Orise Tech OTM8009A is a 3.97" 480x800 TFT LCD panel connected using
-a MIPI-DSI video interface. Its backlight is managed through the DSI link.
-
-Required properties:
-  - compatible: "orisetech,otm8009a"
-  - reg: the virtual channel number of a DSI peripheral
-
-Optional properties:
-  - reset-gpios: a GPIO spec for the reset pin (active low).
-  - power-supply: phandle of the regulator that provides the supply voltage.
-
-Example:
-&dsi {
-	...
-	panel@0 {
-		compatible = "orisetech,otm8009a";
-		reg = <0>;
-		reset-gpios = <&gpioh 7 GPIO_ACTIVE_LOW>;
-		power-supply = <&v1v8>;
-	};
-};

Documentation/devicetree/bindings/display/panel/orisetech,otm8009a.yaml new file +53 -0

new file mode 100644
index 000000000000..6e6ac995c27b
@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/panel/orisetech,otm8009a.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Orise Tech OTM8009A 3.97" 480x800 TFT LCD panel (MIPI-DSI video mode)
+
+maintainers:
+  - Philippe CORNU <[email protected]>
+
+description: |
+             The Orise Tech OTM8009A is a 3.97" 480x800 TFT LCD panel connected using
+             a MIPI-DSI video interface. Its backlight is managed through the DSI link.
+allOf:
+  - $ref: panel-common.yaml#
+
+properties:
+
+  compatible:
+    const: orisetech,otm8009a
+
+  reg:
+    maxItems: 1
+    description: DSI virtual channel
+
+  enable-gpios: true
+  port: true
+  power-supply: true
+
+  reset-gpios:
+    maxItems: 1
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    dsi@0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      panel@0 {
+        compatible = "orisetech,otm8009a";
+        reg = <0>;
+        reset-gpios = <&gpiof 15 0>;
+        power-supply = <&v1v8>;
+      };
+    };
+...
+

Quoted 20 lines · Sam Ravnborg

Hi Joe.

The following warnings triggers on the patch below:

c55d0a554843 (HEAD -> drm-misc-next) dt-bindings: panel: Convert orisetech,otm8009a to json-schema -:15: WARNING:FILE_PATH_CHANGES: added, moved or deleted file(s), does MAINTAINERS need updating? #15:
deleted file mode 100644

-:18: WARNING:DT_SPLIT_BINDING_PATCH: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt

-:43: WARNING:DT_SPLIT_BINDING_PATCH: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt

total: 0 errors, 3 warnings, 0 checks, 53 lines checked

1)
yaml files include maintainer information in the file.
I dunno if this replaces/overrules MAINTAINERS - so first warning may be OK. Also because we delete a file it seems semi relevant.

Quoted 3 lines

2)
As the patch only touches files in Documentation/devicetree/bindings the warning about a separate patch seems wrong.

Rob Herring wrote that bit. He's now cc'd. lkml too.

Quoted 7 lines

But the general feedback - in this very special case - is that checkpatch seems a bit too noisy.

If we as a bonus could get a warning when new yaml files do not use:
# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) That would be great.

Submitted here:

https://lkml.org/lkml/2020/1/29/292