diff mbox series

dt-bindings: Remove last usage of "binding" or "schema" in titles

Message ID 20230615213154.1753313-1-robh@kernel.org (mailing list archive)
State Awaiting Upstream, archived
Headers show
Series dt-bindings: Remove last usage of "binding" or "schema" in titles | expand

Commit Message

Rob Herring (Arm) June 15, 2023, 9:31 p.m. UTC
The Devicetree bindings document does not have to say in the title that
it is a "Devicetree binding", but instead just describe the hardware.

Most of these have been fixed already, so fix the handful that snuck in.
With this, a meta-schema check can be enabled to catch these
automatically.

Signed-off-by: Rob Herring <robh@kernel.org>
---
 .../devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml   | 2 +-
 Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml    | 2 +-
 .../devicetree/bindings/power/reset/restart-handler.yaml        | 2 +-
 .../devicetree/bindings/remoteproc/ti,pru-consumer.yaml         | 2 +-
 .../devicetree/bindings/reserved-memory/framebuffer.yaml        | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

Comments

Marek Vasut June 15, 2023, 10:22 p.m. UTC | #1
On 6/15/23 23:31, Rob Herring wrote:
> The Devicetree bindings document does not have to say in the title that
> it is a "Devicetree binding", but instead just describe the hardware.
> 
> Most of these have been fixed already, so fix the handful that snuck in.
> With this, a meta-schema check can be enabled to catch these
> automatically.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>   .../devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml   | 2 +-
>   Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml    | 2 +-
>   .../devicetree/bindings/power/reset/restart-handler.yaml        | 2 +-
>   .../devicetree/bindings/remoteproc/ti,pru-consumer.yaml         | 2 +-
>   .../devicetree/bindings/reserved-memory/framebuffer.yaml        | 2 +-
>   5 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml b/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
> index 199818b2fb6d..cd0d763ce2f3 100644
> --- a/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
> +++ b/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
> @@ -4,7 +4,7 @@
>   $id: http://devicetree.org/schemas/clock/brcm,bcm63268-timer-clocks.yaml#
>   $schema: http://devicetree.org/meta-schemas/core.yaml#
>   
> -title: Broadcom BCM63268 Timer Clock and Reset Device Tree Bindings
> +title: Broadcom BCM63268 Timer Clock and Reset
>   
>   maintainers:
>     - Álvaro Fernández Rojas <noltari@gmail.com>
> diff --git a/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml b/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
> index ff9600474df2..0a6dc1a6e122 100644
> --- a/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
> +++ b/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
> @@ -4,7 +4,7 @@
>   $id: http://devicetree.org/schemas/clock/imx8mp-audiomix.yaml#
>   $schema: http://devicetree.org/meta-schemas/core.yaml#
>   
> -title: NXP i.MX8MP AudioMIX Block Control Binding
> +title: NXP i.MX8MP AudioMIX Block Control

For AudioMIX:
Reviewed-by: Marek Vasut <marex@denx.de>
Conor Dooley June 15, 2023, 11:07 p.m. UTC | #2
On Thu, Jun 15, 2023 at 03:31:54PM -0600, Rob Herring wrote:

> -title: Restart and shutdown handler generic binding
> +title: Restart and shutdown handler Common Properties

With the new caps for Common Properties, the title here looks a bit odd.
Should probably be s/shutdown handler/Shutdown Handler/ for title case,
but w/e...
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.
Suman Anna June 15, 2023, 11:19 p.m. UTC | #3
On 6/15/23 16:31, Rob Herring wrote:
> The Devicetree bindings document does not have to say in the title that
> it is a "Devicetree binding", but instead just describe the hardware.
> 
> Most of these have been fixed already, so fix the handful that snuck in.
> With this, a meta-schema check can be enabled to catch these
> automatically.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml   | 2 +-
>  Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml    | 2 +-
>  .../devicetree/bindings/power/reset/restart-handler.yaml        | 2 +-
>  .../devicetree/bindings/remoteproc/ti,pru-consumer.yaml         | 2 +-
>  .../devicetree/bindings/reserved-memory/framebuffer.yaml        | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)
> 

...

> diff --git a/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> index c6d86964b72a..35f0bb38f7b2 100644
> --- a/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> +++ b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/remoteproc/ti,pru-consumer.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>  
> -title: Common TI PRU Consumer Binding
> +title: TI PRU Consumer Common Properties
>  
>  maintainers:
>    - Suman Anna <s-anna@ti.com>

For PRU Consumer binding,
Reviewed-by: Suman Anna <s-anna@ti.com>

regards
Suman
Sebastian Reichel June 16, 2023, 12:37 a.m. UTC | #4
Hi,

On Thu, Jun 15, 2023 at 03:31:54PM -0600, Rob Herring wrote:
> The Devicetree bindings document does not have to say in the title that
> it is a "Devicetree binding", but instead just describe the hardware.
> 
> Most of these have been fixed already, so fix the handful that snuck in.
> With this, a meta-schema check can be enabled to catch these
> automatically.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml   | 2 +-
>  Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml    | 2 +-
>  .../devicetree/bindings/power/reset/restart-handler.yaml        | 2 +-
>  .../devicetree/bindings/remoteproc/ti,pru-consumer.yaml         | 2 +-
>  .../devicetree/bindings/reserved-memory/framebuffer.yaml        | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)

...

> diff --git a/Documentation/devicetree/bindings/power/reset/restart-handler.yaml b/Documentation/devicetree/bindings/power/reset/restart-handler.yaml
> index 1f9a2aac53c0..f2ffdd29d52a 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>

Acked-by: Sebastian Reichel <sre@kernel.org>

-- Sebastian
Mathieu Poirier June 16, 2023, 3:20 p.m. UTC | #5
On Thu, 15 Jun 2023 at 15:32, Rob Herring <robh@kernel.org> wrote:
>
> The Devicetree bindings document does not have to say in the title that
> it is a "Devicetree binding", but instead just describe the hardware.
>
> Most of these have been fixed already, so fix the handful that snuck in.
> With this, a meta-schema check can be enabled to catch these
> automatically.
>
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml   | 2 +-
>  Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml    | 2 +-
>  .../devicetree/bindings/power/reset/restart-handler.yaml        | 2 +-
>  .../devicetree/bindings/remoteproc/ti,pru-consumer.yaml         | 2 +-
>  .../devicetree/bindings/reserved-memory/framebuffer.yaml        | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml b/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
> index 199818b2fb6d..cd0d763ce2f3 100644
> --- a/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
> +++ b/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/clock/brcm,bcm63268-timer-clocks.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Broadcom BCM63268 Timer Clock and Reset Device Tree Bindings
> +title: Broadcom BCM63268 Timer Clock and Reset
>
>  maintainers:
>    - Álvaro Fernández Rojas <noltari@gmail.com>
> diff --git a/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml b/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
> index ff9600474df2..0a6dc1a6e122 100644
> --- a/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
> +++ b/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/clock/imx8mp-audiomix.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: NXP i.MX8MP AudioMIX Block Control Binding
> +title: NXP i.MX8MP AudioMIX Block Control
>
>  maintainers:
>    - Marek Vasut <marex@denx.de>
> diff --git a/Documentation/devicetree/bindings/power/reset/restart-handler.yaml b/Documentation/devicetree/bindings/power/reset/restart-handler.yaml
> index 1f9a2aac53c0..f2ffdd29d52a 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/remoteproc/ti,pru-consumer.yaml b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> index c6d86964b72a..35f0bb38f7b2 100644
> --- a/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> +++ b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/remoteproc/ti,pru-consumer.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Common TI PRU Consumer Binding
> +title: TI PRU Consumer Common Properties
>

Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org>

>  maintainers:
>    - Suman Anna <s-anna@ti.com>
> diff --git a/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml b/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml
> index 05b6648b3458..851ec24d6142 100644
> --- a/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml
> +++ b/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml
> @@ -4,7 +4,7 @@
>  $id: http://devicetree.org/schemas/reserved-memory/framebuffer.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: /reserved-memory framebuffer node bindings
> +title: /reserved-memory framebuffer node
>
>  maintainers:
>    - devicetree-spec@vger.kernel.org
> --
> 2.39.2
>
Stephen Boyd June 16, 2023, 6:34 p.m. UTC | #6
Quoting Rob Herring (2023-06-15 14:31:54)
> The Devicetree bindings document does not have to say in the title that
> it is a "Devicetree binding", but instead just describe the hardware.
> 
> Most of these have been fixed already, so fix the handful that snuck in.
> With this, a meta-schema check can be enabled to catch these
> automatically.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---

Acked-by: Stephen Boyd <sboyd@kernel.org>
Rob Herring (Arm) June 16, 2023, 7:56 p.m. UTC | #7
On Thu, 15 Jun 2023 15:31:54 -0600, Rob Herring wrote:
> The Devicetree bindings document does not have to say in the title that
> it is a "Devicetree binding", but instead just describe the hardware.
> 
> Most of these have been fixed already, so fix the handful that snuck in.
> With this, a meta-schema check can be enabled to catch these
> automatically.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml   | 2 +-
>  Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml    | 2 +-
>  .../devicetree/bindings/power/reset/restart-handler.yaml        | 2 +-
>  .../devicetree/bindings/remoteproc/ti,pru-consumer.yaml         | 2 +-
>  .../devicetree/bindings/reserved-memory/framebuffer.yaml        | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml b/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
index 199818b2fb6d..cd0d763ce2f3 100644
--- a/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
+++ b/Documentation/devicetree/bindings/clock/brcm,bcm63268-timer-clocks.yaml
@@ -4,7 +4,7 @@ 
 $id: http://devicetree.org/schemas/clock/brcm,bcm63268-timer-clocks.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: Broadcom BCM63268 Timer Clock and Reset Device Tree Bindings
+title: Broadcom BCM63268 Timer Clock and Reset
 
 maintainers:
   - Álvaro Fernández Rojas <noltari@gmail.com>
diff --git a/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml b/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
index ff9600474df2..0a6dc1a6e122 100644
--- a/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
+++ b/Documentation/devicetree/bindings/clock/imx8mp-audiomix.yaml
@@ -4,7 +4,7 @@ 
 $id: http://devicetree.org/schemas/clock/imx8mp-audiomix.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: NXP i.MX8MP AudioMIX Block Control Binding
+title: NXP i.MX8MP AudioMIX Block Control
 
 maintainers:
   - Marek Vasut <marex@denx.de>
diff --git a/Documentation/devicetree/bindings/power/reset/restart-handler.yaml b/Documentation/devicetree/bindings/power/reset/restart-handler.yaml
index 1f9a2aac53c0..f2ffdd29d52a 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/remoteproc/ti,pru-consumer.yaml b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
index c6d86964b72a..35f0bb38f7b2 100644
--- a/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
+++ b/Documentation/devicetree/bindings/remoteproc/ti,pru-consumer.yaml
@@ -4,7 +4,7 @@ 
 $id: http://devicetree.org/schemas/remoteproc/ti,pru-consumer.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: Common TI PRU Consumer Binding
+title: TI PRU Consumer Common Properties
 
 maintainers:
   - Suman Anna <s-anna@ti.com>
diff --git a/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml b/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml
index 05b6648b3458..851ec24d6142 100644
--- a/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml
+++ b/Documentation/devicetree/bindings/reserved-memory/framebuffer.yaml
@@ -4,7 +4,7 @@ 
 $id: http://devicetree.org/schemas/reserved-memory/framebuffer.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: /reserved-memory framebuffer node bindings
+title: /reserved-memory framebuffer node
 
 maintainers:
   - devicetree-spec@vger.kernel.org