Message ID | 20221117123850.368213-1-krzysztof.kozlowski@linaro.org |
---|---|
Headers | show |
Series | dt-bindings: cleanup titles | expand |
On 17/11/2022 14:23, Andrew Lunn wrote: >> allOf: >> - - $ref: "dma-common.yaml#" >> + - $ref: dma-common.yaml# >> >> >> allOf: >> - - $ref: "dma-common.yaml#" >> + - $ref: dma-common.yaml# > > Looks like some other automated change made its way into this patch. I forgot to mention in commit msg, but maybe better to drop it to reduce noise. Best regards, Krzysztof
On Thu, 17 Nov 2022 13:38:50 +0100 Krzysztof Kozlowski <krzysztof.kozlowski@linaro.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. > > Manual updates to various binding titles. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> FWIW looked at this one for completeness sake. Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
On 17/11/2022 18:19, Rob Herring wrote: > 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. > Ack. Best regards, Krzysztof
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". > 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/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> Hey Krzysztof, Hopefully I've not overlooked something obvious, but it wasnt noted in the commit message - how come these two are "parts" rather than "properties"? The opp one at least don't seem to have much more than properties and patterProperties in it. Thanks, Conor.
On 17/11/2022 18:52, Conor Dooley wrote: > 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". > > >> 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/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> > > Hey Krzysztof, > > Hopefully I've not overlooked something obvious, but it wasnt noted in > the commit message - how come these two are "parts" rather than > "properties"? The opp one at least don't seem to have much more than > properties and patterProperties in it. They should be properties, will fix in v2. Best regards, Krzysztof
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: > >> 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> Thanks, I update these manually, so I can correct the names to ones you mentioned. Thanks. Best regards, Krzysztof