| Message ID | 20241107061124.105930-2-xandfury@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Documentation: dt-bindings: Fix documentation issues | expand |
On Wed, Nov 06, 2024 at 11:11:23PM -0700, Abhinav Saxena wrote: > Fix unintentional word repetitions in devicetree binding documentation: > - usb.txt: Fix repeated "two" > - mvebu-devbus.txt: Fix repeated "from" > - gpio.txt: Fix repeated "Both" > - pinctrl-bindings.txt: Fix repeated "device" > - cavium/bootbus.txt: Fix repeated "one" This we see from the diff. This is trivial commit, so rather write concise commit msg. Please use subject prefixes matching the subsystem. You can get them for example with 'git log --oneline -- DIRECTORY_OR_FILE' on the directory your patch is touching. For bindings, the preferred subjects are explained here: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters With changes above: Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Best regards, Krzysztof
On Wed, Nov 06, 2024 at 11:11:23PM -0700, Abhinav Saxena wrote: > Fix unintentional word repetitions in devicetree binding documentation: > - usb.txt: Fix repeated "two" > - mvebu-devbus.txt: Fix repeated "from" > - gpio.txt: Fix repeated "Both" > - pinctrl-bindings.txt: Fix repeated "device" > - cavium/bootbus.txt: Fix repeated "one" > > These issues were identified using the checkpatch.pl script. > > Signed-off-by: Abhinav Saxena <xandfury@gmail.com> > --- > Documentation/devicetree/bindings/gpio/gpio.txt | 2 +- This and... > .../devicetree/bindings/memory-controllers/mvebu-devbus.txt | 2 +- > Documentation/devicetree/bindings/mips/cavium/bootbus.txt | 2 +- > Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt | 2 +- ...this I'll take. The others need to be converted to schema. > Documentation/devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt | 2 +- > 5 files changed, 5 insertions(+), 5 deletions(-) > > diff --git a/Documentation/devicetree/bindings/gpio/gpio.txt b/Documentation/devicetree/bindings/gpio/gpio.txt > index d82c32217fff..530420475a4f 100644 > --- a/Documentation/devicetree/bindings/gpio/gpio.txt > +++ b/Documentation/devicetree/bindings/gpio/gpio.txt > @@ -304,7 +304,7 @@ pins 50..69. > It is also possible to use pin groups for gpio ranges when pin groups are the > easiest and most convenient mapping. > > -Both both <pinctrl-base> and <count> must set to 0 when using named pin groups > +Both <pinctrl-base> and <count> must set to 0 when using named pin groups > names. > > The property gpio-ranges-group-names must contain exactly one string for each > diff --git a/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt b/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt > index 8b9388cc1ccc..1983d7eabd2b 100644 > --- a/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt > +++ b/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt > @@ -43,7 +43,7 @@ Read parameters: > - devbus,bus-width: Defines the bus width, in bits (e.g. <16>). > Mandatory, except if devbus,keep-config is used. > > - - devbus,badr-skew-ps: Defines the time delay from from A[2:0] toggle, > + - devbus,badr-skew-ps: Defines the time delay from A[2:0] toggle, > to read data sample. This parameter is useful for > synchronous pipelined devices, where the address > precedes the read data by one or two cycles. > diff --git a/Documentation/devicetree/bindings/mips/cavium/bootbus.txt b/Documentation/devicetree/bindings/mips/cavium/bootbus.txt > index 6581478225a2..1bc655d285ce 100644 > --- a/Documentation/devicetree/bindings/mips/cavium/bootbus.txt > +++ b/Documentation/devicetree/bindings/mips/cavium/bootbus.txt > @@ -15,7 +15,7 @@ Properties: > > - #size-cells: Must be <1>. > > -- ranges: There must be one one triplet of (child-bus-address, > +- ranges: There must be one triplet of (child-bus-address, > parent-bus-address, length) for each active chip select. If the > length element for any triplet is zero, the chip select is disabled, > making it inactive. > diff --git a/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt b/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > index 6904072d3944..500b76ba2ab3 100644 > --- a/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > +++ b/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > @@ -18,7 +18,7 @@ states. The number and names of those states is defined by the client device's > own binding. > > The common pinctrl bindings defined in this file provide an infrastructure > -for client device device tree nodes to map those state names to the pin > +for client device tree nodes to map those state names to the pin Actually I think this was correct. See "client device" used above. Maybe "client device Devicetree nodes" would be a bit clearer and use the right form of Devicetree. Rob
diff --git a/Documentation/devicetree/bindings/gpio/gpio.txt b/Documentation/devicetree/bindings/gpio/gpio.txt index d82c32217fff..530420475a4f 100644 --- a/Documentation/devicetree/bindings/gpio/gpio.txt +++ b/Documentation/devicetree/bindings/gpio/gpio.txt @@ -304,7 +304,7 @@ pins 50..69. It is also possible to use pin groups for gpio ranges when pin groups are the easiest and most convenient mapping. -Both both <pinctrl-base> and <count> must set to 0 when using named pin groups +Both <pinctrl-base> and <count> must set to 0 when using named pin groups names. The property gpio-ranges-group-names must contain exactly one string for each diff --git a/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt b/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt index 8b9388cc1ccc..1983d7eabd2b 100644 --- a/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt +++ b/Documentation/devicetree/bindings/memory-controllers/mvebu-devbus.txt @@ -43,7 +43,7 @@ Read parameters: - devbus,bus-width: Defines the bus width, in bits (e.g. <16>). Mandatory, except if devbus,keep-config is used. - - devbus,badr-skew-ps: Defines the time delay from from A[2:0] toggle, + - devbus,badr-skew-ps: Defines the time delay from A[2:0] toggle, to read data sample. This parameter is useful for synchronous pipelined devices, where the address precedes the read data by one or two cycles. diff --git a/Documentation/devicetree/bindings/mips/cavium/bootbus.txt b/Documentation/devicetree/bindings/mips/cavium/bootbus.txt index 6581478225a2..1bc655d285ce 100644 --- a/Documentation/devicetree/bindings/mips/cavium/bootbus.txt +++ b/Documentation/devicetree/bindings/mips/cavium/bootbus.txt @@ -15,7 +15,7 @@ Properties: - #size-cells: Must be <1>. -- ranges: There must be one one triplet of (child-bus-address, +- ranges: There must be one triplet of (child-bus-address, parent-bus-address, length) for each active chip select. If the length element for any triplet is zero, the chip select is disabled, making it inactive. diff --git a/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt b/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt index 6904072d3944..500b76ba2ab3 100644 --- a/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt +++ b/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt @@ -18,7 +18,7 @@ states. The number and names of those states is defined by the client device's own binding. The common pinctrl bindings defined in this file provide an infrastructure -for client device device tree nodes to map those state names to the pin +for client device tree nodes to map those state names to the pin configuration used by those states. Note that pin controllers themselves may also be client devices of themselves. diff --git a/Documentation/devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt b/Documentation/devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt index da13999337a4..682db2b561bb 100644 --- a/Documentation/devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt +++ b/Documentation/devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt @@ -3,7 +3,7 @@ Freescale QUICC Engine USB Controller Required properties: - compatible : should be "fsl,<chip>-qe-usb", "fsl,mpc8323-qe-usb". - reg : the first two cells should contain usb registers location and - length, the next two two cells should contain PRAM location and + length, the next two cells should contain PRAM location and length. - interrupts : should contain USB interrupt. - fsl,fullspeed-clock : specifies the full speed USB clock source:
Fix unintentional word repetitions in devicetree binding documentation: - usb.txt: Fix repeated "two" - mvebu-devbus.txt: Fix repeated "from" - gpio.txt: Fix repeated "Both" - pinctrl-bindings.txt: Fix repeated "device" - cavium/bootbus.txt: Fix repeated "one" These issues were identified using the checkpatch.pl script. Signed-off-by: Abhinav Saxena <xandfury@gmail.com> --- Documentation/devicetree/bindings/gpio/gpio.txt | 2 +- .../devicetree/bindings/memory-controllers/mvebu-devbus.txt | 2 +- Documentation/devicetree/bindings/mips/cavium/bootbus.txt | 2 +- Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt | 2 +- Documentation/devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-)