[PATCH 0/2] Documentation: dt-bindings: Fix documentation issues

[PATCH 0/2] Documentation: dt-bindings: Fix documentation issues

[Abhinav Saxena]

This small patch series fixes documentation issues in devicetree bindings,
specifically addressing repeated words and trailing whitespace found using
checkpatch.pl script. No functional changes are included.

Patch 1 fixes repeated words in various binding documents, while patch 2
removes trailing whitespace from several files.

Signed-off-by: Abhinav Saxena <xandfury@gmail.com>

Abhinav Saxena (2):
  Documentation: dt-bindings: Fix repeated words
  Documentation: dt-bindings: Remove trailing whitespace

 Documentation/devicetree/bindings/gpio/gpio.txt        |  2 +-
 .../devicetree/bindings/interrupt-controller/msi.txt   | 10 +++++-----
 .../interrupt-controller/nvidia,tegra20-ictlr.txt      |  2 +-
 .../bindings/memory-controllers/mvebu-devbus.txt       |  2 +-
 .../devicetree/bindings/mips/cavium/bootbus.txt        |  2 +-
 .../devicetree/bindings/pinctrl/pinctrl-bindings.txt   |  2 +-
 .../bindings/regulator/regulator-max77620.txt          |  4 ++--
 .../devicetree/bindings/soc/fsl/cpm_qe/qe/usb.txt      |  2 +-
 8 files changed, 13 insertions(+), 13 deletions(-)

-- 
2.34.1

[PATCH 1/2] Documentation: dt-bindings: Fix repeated words

[Abhinav Saxena]

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(-)

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:
-- 
2.34.1

[PATCH 2/2] Documentation: dt-bindings: Remove trailing whitespace

[Abhinav Saxena]

Remove trailing whitespace from devicetree binding documentation files:
- regulator/regulator-max77620.txt
- interrupt-controller/nvidia,tegra20-ictlr.txt
- interrupt-controller/msi.txt

No functional changes. Issues detected using checkpatch.pl script.

Signed-off-by: Abhinav Saxena <xandfury@gmail.com>
---
 .../devicetree/bindings/interrupt-controller/msi.txt   | 10 +++++-----
 .../interrupt-controller/nvidia,tegra20-ictlr.txt      |  2 +-
 .../bindings/regulator/regulator-max77620.txt          |  4 ++--
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/devicetree/bindings/interrupt-controller/msi.txt b/Documentation/devicetree/bindings/interrupt-controller/msi.txt
index c20b51df7138..2109a3454cf6 100644
--- a/Documentation/devicetree/bindings/interrupt-controller/msi.txt
+++ b/Documentation/devicetree/bindings/interrupt-controller/msi.txt
@@ -12,17 +12,17 @@ potentially including additional information.
 MSIs are distinguished by some combination of:
 
 - The doorbell (the MMIO address written to).
-  
+
   Devices may be configured by software to write to arbitrary doorbells which
   they can address. An MSI controller may feature a number of doorbells.
 
 - The payload (the value written to the doorbell).
-  
+
   Devices may be configured to write an arbitrary payload chosen by software.
   MSI controllers may have restrictions on permitted payloads.
 
 - Sideband information accompanying the write.
-  
+
   Typically this is neither configurable nor probeable, and depends on the path
   taken through the memory system (i.e. it is a property of the combination of
   MSI controller and device rather than a property of either in isolation).
@@ -48,7 +48,7 @@ Optional properties:
   not encode doorbells or payloads as these can be configured dynamically.
 
   The meaning of the msi-specifier is defined by the device tree binding of
-  the specific MSI controller. 
+  the specific MSI controller.
 
 
 MSI clients
@@ -117,7 +117,7 @@ Example
 		reg = <0x1 0xf00>;
 		compatible = "vendor-c,some-device";
 
-		/* 
+		/*
 		 * Can generate MSIs to either A or B.
 		 */
 		msi-parent = <&msi_a>, <&msi_b 0x17>;
diff --git a/Documentation/devicetree/bindings/interrupt-controller/nvidia,tegra20-ictlr.txt b/Documentation/devicetree/bindings/interrupt-controller/nvidia,tegra20-ictlr.txt
index 2ff356640100..0c37e569e6f3 100644
--- a/Documentation/devicetree/bindings/interrupt-controller/nvidia,tegra20-ictlr.txt
+++ b/Documentation/devicetree/bindings/interrupt-controller/nvidia,tegra20-ictlr.txt
@@ -12,7 +12,7 @@ Required properties:
 - compatible : should be: "nvidia,tegra<chip>-ictlr". The LIC on
   subsequent SoCs remained backwards-compatible with Tegra30, so on
   Tegra generations later than Tegra30 the compatible value should
-  include "nvidia,tegra30-ictlr".	
+  include "nvidia,tegra30-ictlr".
 - reg : Specifies base physical address and size of the registers.
   Each controller must be described separately (Tegra20 has 4 of them,
   whereas Tegra30 and later have 5).
diff --git a/Documentation/devicetree/bindings/regulator/regulator-max77620.txt b/Documentation/devicetree/bindings/regulator/regulator-max77620.txt
index bcf788897e44..7484c0728e27 100644
--- a/Documentation/devicetree/bindings/regulator/regulator-max77620.txt
+++ b/Documentation/devicetree/bindings/regulator/regulator-max77620.txt
@@ -65,14 +65,14 @@ Following are additional properties:
 					Valid values are 0 to 7.
 					This is applicable if FPS source is
 					selected as FPS0, FPS1 or FPS2.
-			
+
 - maxim,active-fps-power-down-slot:	Sequencing event slot number on which
 					the regulator get disabled when master
 					FPS input event set to LOW.
 					Valid values are 0 to 7.
 					This is applicable if FPS source is
 					selected as FPS0, FPS1 or FPS2.
-			
+
 - maxim,suspend-fps-source:		This is same as property
 					"maxim,active-fps-source" but value
 					get configured when system enters in
-- 
2.34.1

Re: [PATCH 1/2] Documentation: dt-bindings: Fix repeated words

[Krzysztof Kozlowski]

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

Re: [PATCH 2/2] Documentation: dt-bindings: Remove trailing whitespace

[Krzysztof Kozlowski]

On Wed, Nov 06, 2024 at 11:11:24PM -0700, Abhinav Saxena wrote:
> Remove trailing whitespace from devicetree binding documentation files:
> - regulator/regulator-max77620.txt
> - interrupt-controller/nvidia,tegra20-ictlr.txt
> - interrupt-controller/msi.txt
> 
> No functional changes. Issues detected using checkpatch.pl script.

Instead I would prefer these files to be converted to DT schema which
would result in their full removal.

Best regards,
Krzysztof

Re: [PATCH 2/2] Documentation: dt-bindings: Remove trailing whitespace

[Rob Herring]

On Thu, Nov 07, 2024 at 12:07:46PM +0100, Krzysztof Kozlowski wrote:
> On Wed, Nov 06, 2024 at 11:11:24PM -0700, Abhinav Saxena wrote:
> > Remove trailing whitespace from devicetree binding documentation files:
> > - regulator/regulator-max77620.txt
> > - interrupt-controller/nvidia,tegra20-ictlr.txt
> > - interrupt-controller/msi.txt
> > 
> > No functional changes. Issues detected using checkpatch.pl script.
> 
> Instead I would prefer these files to be converted to DT schema which
> would result in their full removal.

Yes. I don't take fixes for .txt bindings.

Rob

Re: [PATCH 1/2] Documentation: dt-bindings: Fix repeated words

[Rob Herring]

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