Thread (26 messages) 26 messages, 8 authors, 2022-11-18

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

From: Krzysztof Kozlowski <hidden>
Date: 2022-11-18 08:29:31
Also in: alsa-devel, linux-arm-kernel, linux-arm-msm, linux-can, linux-clk, linux-devicetree, linux-gpio, linux-iio, linux-leds, linux-media, linux-mips, linux-mmc, linux-pci, linux-pm, linux-pwm, linux-riscv, linux-rtc, linux-serial, linux-spi, linux-usb, linux-watchdog, lkml, netdev

On 17/11/2022 22:07, Miquel Raynal wrote:
Hi Krzysztof,

krzysztof.kozlowski@linaro.org wrote on Thu, 17 Nov 2022 13:38:42 +0100:
quoted
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 <redacted>
---
 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(-)
[...]
quoted
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"
quoted
 
 maintainers:
   - Miquel Raynal [off-list ref]
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>
Thanks, I update these manually, so I can correct the names to ones you
mentioned. Thanks.

Best regards,
Krzysztof
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help