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

Rob Herring
2022-11-17T17:19:44Z

On Thu, Nov 17, 2022 at 01:38:42PM +0100, Krzysztof Kozlowski wrote:
> 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".

It's titles, so capitalize 'Common Properties'. Someday we may generate
a document from all the schemas.

> 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/clock/qcom,gcc.yaml b/Documentation/devicetree/bindings/clock/qcom,gcc.yaml
> index 1ab416c83c8d..d2de3d128b73 100644
> --- a/Documentation/devicetree/bindings/clock/qcom,gcc.yaml
> +++ b/Documentation/devicetree/bindings/clock/qcom,gcc.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/clock/qcom,gcc.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Qualcomm Global Clock & Reset Controller Common Bindings
> +title: Qualcomm Global Clock & Reset Controller common parts
>
> maintainers:
> - Stephen Boyd <sboyd@kernel.org>
> diff --git a/Documentation/devicetree/bindings/dma/dma-common.yaml b/Documentation/devicetree/bindings/dma/dma-common.yaml
> index ad06d36af208..9b7b94fdbb0b 100644
> --- a/Documentation/devicetree/bindings/dma/dma-common.yaml
> +++ b/Documentation/devicetree/bindings/dma/dma-common.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/dma/dma-common.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: DMA Engine Generic Binding
> +title: DMA Engine common properties
>
> maintainers:
> - Vinod Koul <vkoul@kernel.org>
> diff --git a/Documentation/devicetree/bindings/dma/dma-controller.yaml b/Documentation/devicetree/bindings/dma/dma-controller.yaml
> index 6d3727267fa8..225a141c7b5c 100644
> --- a/Documentation/devicetree/bindings/dma/dma-controller.yaml
> +++ b/Documentation/devicetree/bindings/dma/dma-controller.yaml
> @@ -4,13 +4,13 @@
> $id: http://devicetree.org/schemas/dma/dma-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: DMA Controller Generic Binding
> +title: DMA Controller common properties
>
> maintainers:
> - Vinod Koul <vkoul@kernel.org>
>
> allOf:
> - - $ref: "dma-common.yaml#"
> + - $ref: dma-common.yaml#
>
> # Everything else is described in the common file
> properties:
> diff --git a/Documentation/devicetree/bindings/dma/dma-router.yaml b/Documentation/devicetree/bindings/dma/dma-router.yaml
> index 4b817f5dc30e..0ebd7bc6232b 100644
> --- a/Documentation/devicetree/bindings/dma/dma-router.yaml
> +++ b/Documentation/devicetree/bindings/dma/dma-router.yaml
> @@ -4,13 +4,13 @@
> $id: http://devicetree.org/schemas/dma/dma-router.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: DMA Router Generic Binding
> +title: DMA Router common properties
>
> maintainers:
> - Vinod Koul <vkoul@kernel.org>
>
> allOf:
> - - $ref: "dma-common.yaml#"
> + - $ref: dma-common.yaml#
>
> description:
> DMA routers are transparent IP blocks used to route DMA request
> diff --git a/Documentation/devicetree/bindings/iio/adc/adc.yaml b/Documentation/devicetree/bindings/iio/adc/adc.yaml
> index db348fcbb52c..bd0f5fae256e 100644
> --- a/Documentation/devicetree/bindings/iio/adc/adc.yaml
> +++ b/Documentation/devicetree/bindings/iio/adc/adc.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/iio/adc/adc.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Generic IIO bindings for ADC channels
> +title: IIO common properties for ADC channels
>
> maintainers:
> - Jonathan Cameron <jic23@kernel.org>
> diff --git a/Documentation/devicetree/bindings/media/video-interface-devices.yaml b/Documentation/devicetree/bindings/media/video-interface-devices.yaml
> index 4527f56a5a6e..bd719cb1813e 100644
> --- a/Documentation/devicetree/bindings/media/video-interface-devices.yaml
> +++ b/Documentation/devicetree/bindings/media/video-interface-devices.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/media/video-interface-devices.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Common bindings for video receiver and transmitter devices
> +title: Common properties for video receiver and transmitter devices
>
> maintainers:
> - Jacopo Mondi <jacopo@jmondi.org>
> diff --git a/Documentation/devicetree/bindings/media/video-interfaces.yaml b/Documentation/devicetree/bindings/media/video-interfaces.yaml
> index 68c3b9871cf3..e8cf73794772 100644
> --- a/Documentation/devicetree/bindings/media/video-interfaces.yaml
> +++ b/Documentation/devicetree/bindings/media/video-interfaces.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/media/video-interfaces.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Common bindings for video receiver and transmitter interface endpoints
> +title: Common properties for video receiver and transmitter interface endpoints
>
> maintainers:
> - Sakari Ailus <sakari.ailus@linux.intel.com>
> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> index 802e3ca8be4d..a17f49738abd 100644
> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/mmc/mmc-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: MMC Controller Generic Binding
> +title: MMC Controller common properties
>
> maintainers:
> - Ulf Hansson <ulf.hansson@linaro.org>
> 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
>
> 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
>
> maintainers:
> - Miquel Raynal <miquel.raynal@bootlin.com>
> diff --git a/Documentation/devicetree/bindings/net/bluetooth/bluetooth-controller.yaml b/Documentation/devicetree/bindings/net/bluetooth/bluetooth-controller.yaml
> index 9309dc40f54f..8715adff5eaf 100644
> --- a/Documentation/devicetree/bindings/net/bluetooth/bluetooth-controller.yaml
> +++ b/Documentation/devicetree/bindings/net/bluetooth/bluetooth-controller.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/net/bluetooth/bluetooth-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Bluetooth Controller Generic Binding
> +title: Bluetooth Controller common properties
>
> maintainers:
> - Marcel Holtmann <marcel@holtmann.org>
> diff --git a/Documentation/devicetree/bindings/net/can/can-controller.yaml b/Documentation/devicetree/bindings/net/can/can-controller.yaml
> index 1f0e98051074..3747b46cf9b6 100644
> --- a/Documentation/devicetree/bindings/net/can/can-controller.yaml
> +++ b/Documentation/devicetree/bindings/net/can/can-controller.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/net/can/can-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: CAN Controller Generic Binding
> +title: CAN Controller common properties
>
> maintainers:
> - Marc Kleine-Budde <mkl@pengutronix.de>
> diff --git a/Documentation/devicetree/bindings/net/ethernet-controller.yaml b/Documentation/devicetree/bindings/net/ethernet-controller.yaml
> index 3aef506fa158..26502c0f2aff 100644
> --- a/Documentation/devicetree/bindings/net/ethernet-controller.yaml
> +++ b/Documentation/devicetree/bindings/net/ethernet-controller.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/net/ethernet-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Ethernet Controller Generic Binding
> +title: Ethernet Controller common properties
>
> maintainers:
> - David S. Miller <davem@davemloft.net>
> diff --git a/Documentation/devicetree/bindings/net/ethernet-phy.yaml b/Documentation/devicetree/bindings/net/ethernet-phy.yaml
> index ad808e9ce5b9..0aa1b60e78cc 100644
> --- a/Documentation/devicetree/bindings/net/ethernet-phy.yaml
> +++ b/Documentation/devicetree/bindings/net/ethernet-phy.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/net/ethernet-phy.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Ethernet PHY Generic Binding
> +title: Ethernet PHY common properties
>
> maintainers:
> - Andrew Lunn <andrew@lunn.ch>
> diff --git a/Documentation/devicetree/bindings/net/mdio.yaml b/Documentation/devicetree/bindings/net/mdio.yaml
> index b5706d4e7e38..b184689dd6b2 100644
> --- a/Documentation/devicetree/bindings/net/mdio.yaml
> +++ b/Documentation/devicetree/bindings/net/mdio.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/net/mdio.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: MDIO Bus Generic Binding
> +title: MDIO Bus common properties
>
> maintainers:
> - Andrew Lunn <andrew@lunn.ch>
> diff --git a/Documentation/devicetree/bindings/opp/opp-v2-base.yaml b/Documentation/devicetree/bindings/opp/opp-v2-base.yaml
> index cf9c2f7bddc2..20ac432dc683 100644
> --- a/Documentation/devicetree/bindings/opp/opp-v2-base.yaml
> +++ b/Documentation/devicetree/bindings/opp/opp-v2-base.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/opp/opp-v2-base.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Generic OPP (Operating Performance Points) Common Binding
> +title: Generic OPP (Operating Performance Points) common parts
>
> maintainers:
> - Viresh Kumar <viresh.kumar@linaro.org>
> diff --git a/Documentation/devicetree/bindings/power/reset/restart-handler.yaml b/Documentation/devicetree/bindings/power/reset/restart-handler.yaml
> index 1f9a2aac53c0..8b52fd156d4c 100644
> --- a/Documentation/devicetree/bindings/power/reset/restart-handler.yaml
> +++ b/Documentation/devicetree/bindings/power/reset/restart-handler.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/power/reset/restart-handler.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Restart and shutdown handler generic binding
> +title: Restart and shutdown handler common properties
>
> maintainers:
> - Sebastian Reichel <sre@kernel.org>
> diff --git a/Documentation/devicetree/bindings/rtc/rtc.yaml b/Documentation/devicetree/bindings/rtc/rtc.yaml
> index 0ec3551f12dd..00848a5a409e 100644
> --- a/Documentation/devicetree/bindings/rtc/rtc.yaml
> +++ b/Documentation/devicetree/bindings/rtc/rtc.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/rtc/rtc.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: RTC Generic Binding
> +title: Real Time Clock common properties
>
> maintainers:
> - Alexandre Belloni <alexandre.belloni@bootlin.com>
> diff --git a/Documentation/devicetree/bindings/soundwire/soundwire-controller.yaml b/Documentation/devicetree/bindings/soundwire/soundwire-controller.yaml
> index 4aad121eff3f..2176033850dc 100644
> --- a/Documentation/devicetree/bindings/soundwire/soundwire-controller.yaml
> +++ b/Documentation/devicetree/bindings/soundwire/soundwire-controller.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/soundwire/soundwire-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: SoundWire Controller Generic Binding
> +title: SoundWire Controller common properties
>
> maintainers:
> - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
> diff --git a/Documentation/devicetree/bindings/spi/spi-controller.yaml b/Documentation/devicetree/bindings/spi/spi-controller.yaml
> index 01042a7f382e..6bbe073f894b 100644
> --- a/Documentation/devicetree/bindings/spi/spi-controller.yaml
> +++ b/Documentation/devicetree/bindings/spi/spi-controller.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/spi/spi-controller.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: SPI Controller Generic Binding
> +title: SPI Controller common properties
>
> maintainers:
> - Mark Brown <broonie@kernel.org>
> diff --git a/Documentation/devicetree/bindings/watchdog/watchdog.yaml b/Documentation/devicetree/bindings/watchdog/watchdog.yaml
> index e3dfb02f0ca5..6875cf1c3159 100644
> --- a/Documentation/devicetree/bindings/watchdog/watchdog.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/watchdog.yaml
> @@ -4,7 +4,7 @@
> $id: http://devicetree.org/schemas/watchdog/watchdog.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Watchdog Generic Bindings
> +title: Watchdog common properties
>
> maintainers:
> - Guenter Roeck <linux@roeck-us.net>
> --
> 2.34.1
>
>