Re: [RFC PATCH 1/9] dt-bindings: drop redundant part of title of shared bindings

From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Cc: Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Andrew Lunn <andrew@lunn.ch>,
	devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-clk@vger.kernel.org,
	linux-riscv@lists.infradead.org, linux-arm-msm@vger.kernel.org,
	linux-pm@vger.kernel.org, linux-gpio@vger.kernel.org,
	linux-iio@vger.kernel.org, linux-input@vger.kernel.org,
	linux-leds@vger.kernel.org, linux-media@vger.kernel.org,
	linux-mips@vger.kernel.org, linux-mmc@vger.kernel.org,
	linux-mtd@lists.infradead.org, netdev@vger.kernel.org,
	linux-can@vger.kernel.org, linux-pci@vger.kernel.org,
	linux-pwm@vger.kernel.org, linux-rtc@vger.kernel.org,
	linux-serial@vger.kernel.org, alsa-devel@alsa-project.org,
	linux-spi@vger.kernel.org, linux-usb@vger.kernel.org,
	virtualization@lists.linux-foundation.org,
	linux-watchdog@vger.kernel.org
Subject: Re: [RFC PATCH 1/9] dt-bindings: drop redundant part of title of shared bindings
Date: Thu, 17 Nov 2022 22:07:56 +0100	[thread overview]
Message-ID: <20221117220756.7a1bf734@xps-13> (raw)
In-Reply-To: <20221117123850.368213-2-krzysztof.kozlowski@linaro.org>

Hi Krzysztof,

krzysztof.kozlowski@linaro.org wrote on Thu, 17 Nov 2022 13:38:42 +0100:

> The Devicetree bindings document does not have to say in the title that
> it is a "binding", but instead just describe the hardware.  For shared
> (re-usable) schemas, name them all as "common properties".
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> ---
>  Documentation/devicetree/bindings/clock/qcom,gcc.yaml         | 2 +-
>  Documentation/devicetree/bindings/dma/dma-common.yaml         | 2 +-
>  Documentation/devicetree/bindings/dma/dma-controller.yaml     | 4 ++--
>  Documentation/devicetree/bindings/dma/dma-router.yaml         | 4 ++--
>  Documentation/devicetree/bindings/iio/adc/adc.yaml            | 2 +-
>  .../devicetree/bindings/media/video-interface-devices.yaml    | 2 +-
>  Documentation/devicetree/bindings/media/video-interfaces.yaml | 2 +-
>  Documentation/devicetree/bindings/mmc/mmc-controller.yaml     | 2 +-
>  Documentation/devicetree/bindings/mtd/nand-chip.yaml          | 2 +-
>  Documentation/devicetree/bindings/mtd/nand-controller.yaml    | 2 +-
>  .../bindings/net/bluetooth/bluetooth-controller.yaml          | 2 +-
>  Documentation/devicetree/bindings/net/can/can-controller.yaml | 2 +-
>  .../devicetree/bindings/net/ethernet-controller.yaml          | 2 +-
>  Documentation/devicetree/bindings/net/ethernet-phy.yaml       | 2 +-
>  Documentation/devicetree/bindings/net/mdio.yaml               | 2 +-
>  Documentation/devicetree/bindings/opp/opp-v2-base.yaml        | 2 +-
>  .../devicetree/bindings/power/reset/restart-handler.yaml      | 2 +-
>  Documentation/devicetree/bindings/rtc/rtc.yaml                | 2 +-
>  .../devicetree/bindings/soundwire/soundwire-controller.yaml   | 2 +-
>  Documentation/devicetree/bindings/spi/spi-controller.yaml     | 2 +-
>  Documentation/devicetree/bindings/watchdog/watchdog.yaml      | 2 +-
>  21 files changed, 23 insertions(+), 23 deletions(-)
> 

[...]

> diff --git a/Documentation/devicetree/bindings/mtd/nand-chip.yaml b/Documentation/devicetree/bindings/mtd/nand-chip.yaml
> index 97ac3a3fbb52..20b195ef9b70 100644
> --- a/Documentation/devicetree/bindings/mtd/nand-chip.yaml
> +++ b/Documentation/devicetree/bindings/mtd/nand-chip.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/mtd/nand-chip.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>  
> -title: NAND Chip and NAND Controller Generic Binding
> +title: NAND Chip and NAND Controller common properties

I only see this now but the title should be

	"NAND chip common properties"

>  
>  maintainers:
>    - Miquel Raynal <miquel.raynal@bootlin.com>
> diff --git a/Documentation/devicetree/bindings/mtd/nand-controller.yaml b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
> index 359a015d4e5a..a004efc42842 100644
> --- a/Documentation/devicetree/bindings/mtd/nand-controller.yaml
> +++ b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/mtd/nand-controller.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>  
> -title: NAND Chip and NAND Controller Generic Binding
> +title: NAND Chip and NAND Controller common properties

And here just "NAND controller..."

Of course the original purpose of your series is more to clean those
titles rather than fixing them and if you disagree I am fine doing it
myself aside, but if you could at the same time make the title more
accurate that would be perfect.

Either ways:

Acked-by: Miquel Raynal <miquel.raynal@bootlin.com>

Cheers,
Miquèl