[PATCH] Documentation: proofreading Documentation

[PATCH] Documentation: proofreading Documentation

[Armin]

Fixed some spelling issues in documentations.

Signed-off-by: Armin <Armin.Mahdilou@gmail.com>
---
 Documentation/ABI/testing/configfs-usb-gadget-midi2 | 2 +-
 Documentation/input/devices/elantech.rst            | 2 +-
 Documentation/nvme/nvme-pci-endpoint-target.rst     | 2 +-
 Documentation/sound/soc/machine.rst                 | 2 +-
 Documentation/usb/gadget-testing.rst                | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-midi2 b/Documentation/ABI/testing/configfs-usb-gadget-midi2
index 0eac3aaba137..d76a52e2ca7f 100644
--- a/Documentation/ABI/testing/configfs-usb-gadget-midi2
+++ b/Documentation/ABI/testing/configfs-usb-gadget-midi2
@@ -47,7 +47,7 @@ Description:
 		midi1_first_group	The first UMP Group number for MIDI 1.0 (0-15)
 		midi1_num_groups	The number of groups for MIDI 1.0 (0-16)
 		ui_hint			0: unknown, 1: receiver, 2: sender, 3: both
-		midi_ci_verison		Supported MIDI-CI version number (8 bit)
+		midi_ci_version		Supported MIDI-CI version number (8 bit)
 		is_midi1		Legacy MIDI 1.0 device (0, 1 or 2)
 		sysex8_streams		Max number of SysEx8 streams (8 bit)
 		active			Active FB flag (0 or 1)
diff --git a/Documentation/input/devices/elantech.rst b/Documentation/input/devices/elantech.rst
index c3374a7ce7af..98163a258b83 100644
--- a/Documentation/input/devices/elantech.rst
+++ b/Documentation/input/devices/elantech.rst
@@ -556,7 +556,7 @@ Note on debounce:
 In case the box has unstable power supply or other electricity issues, or
 when number of finger changes, F/W would send "debounce packet" to inform
 driver that the hardware is in debounce status.
-The debouce packet has the following signature::
+The debounce packet has the following signature::
 
     byte 0: 0xc4
     byte 1: 0xff
diff --git a/Documentation/nvme/nvme-pci-endpoint-target.rst b/Documentation/nvme/nvme-pci-endpoint-target.rst
index 66e7b7d869b4..b699595d1762 100644
--- a/Documentation/nvme/nvme-pci-endpoint-target.rst
+++ b/Documentation/nvme/nvme-pci-endpoint-target.rst
@@ -86,7 +86,7 @@ configurable through configfs before starting the controller. To avoid issues
 with excessive local memory usage for executing commands, MDTS defaults to 512
 KB and is limited to a maximum of 2 MB (arbitrary limit).
 
-Mimimum number of PCI Address Mapping Windows Required
+Minimum number of PCI Address Mapping Windows Required
 ------------------------------------------------------
 
 Most PCI endpoint controllers provide a limited number of mapping windows for
diff --git a/Documentation/sound/soc/machine.rst b/Documentation/sound/soc/machine.rst
index 9db132bc0070..1828f5edca3e 100644
--- a/Documentation/sound/soc/machine.rst
+++ b/Documentation/sound/soc/machine.rst
@@ -75,7 +75,7 @@ In the above struct, dai’s are registered using names but you can pass
 either dai name or device tree node but not both. Also, names used here
 for cpu/codec/platform dais should be globally unique.
 
-Additionaly below example macro can be used to register cpu, codec and
+Additionally below example macro can be used to register cpu, codec and
 platform dai::
 
   SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
index bf555c2270f5..1998dc146c56 100644
--- a/Documentation/usb/gadget-testing.rst
+++ b/Documentation/usb/gadget-testing.rst
@@ -1050,7 +1050,7 @@ Its attributes are:
 	midi1_num_groups	The number of groups for MIDI 1.0 (0-16)
 	ui_hint			UI-hint of this FB
 				0: unknown, 1: receiver, 2: sender, 3: both
-	midi_ci_verison		Supported MIDI-CI version number (8 bit)
+	midi_ci_version		Supported MIDI-CI version number (8 bit)
 	is_midi1		Legacy MIDI 1.0 device (0-2)
 				0: MIDI 2.0 device,
 				1: MIDI 1.0 without restriction, or
-- 
2.47.2

Re: [PATCH] Documentation: proofreading Documentation

[Randy Dunlap]

On 2/9/25 8:17 PM, Armin wrote:
> Fixed some spelling issues in documentations.
> 
> Signed-off-by: Armin <Armin.Mahdilou@gmail.com>

Looks good. Thanks.

Acked-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/ABI/testing/configfs-usb-gadget-midi2 | 2 +-
>  Documentation/input/devices/elantech.rst            | 2 +-
>  Documentation/nvme/nvme-pci-endpoint-target.rst     | 2 +-
>  Documentation/sound/soc/machine.rst                 | 2 +-
>  Documentation/usb/gadget-testing.rst                | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/configfs-usb-gadget-midi2 b/Documentation/ABI/testing/configfs-usb-gadget-midi2
> index 0eac3aaba137..d76a52e2ca7f 100644
> --- a/Documentation/ABI/testing/configfs-usb-gadget-midi2
> +++ b/Documentation/ABI/testing/configfs-usb-gadget-midi2
> @@ -47,7 +47,7 @@ Description:
>  		midi1_first_group	The first UMP Group number for MIDI 1.0 (0-15)
>  		midi1_num_groups	The number of groups for MIDI 1.0 (0-16)
>  		ui_hint			0: unknown, 1: receiver, 2: sender, 3: both
> -		midi_ci_verison		Supported MIDI-CI version number (8 bit)
> +		midi_ci_version		Supported MIDI-CI version number (8 bit)
>  		is_midi1		Legacy MIDI 1.0 device (0, 1 or 2)
>  		sysex8_streams		Max number of SysEx8 streams (8 bit)
>  		active			Active FB flag (0 or 1)
> diff --git a/Documentation/input/devices/elantech.rst b/Documentation/input/devices/elantech.rst
> index c3374a7ce7af..98163a258b83 100644
> --- a/Documentation/input/devices/elantech.rst
> +++ b/Documentation/input/devices/elantech.rst
> @@ -556,7 +556,7 @@ Note on debounce:
>  In case the box has unstable power supply or other electricity issues, or
>  when number of finger changes, F/W would send "debounce packet" to inform
>  driver that the hardware is in debounce status.
> -The debouce packet has the following signature::
> +The debounce packet has the following signature::
>  
>      byte 0: 0xc4
>      byte 1: 0xff
> diff --git a/Documentation/nvme/nvme-pci-endpoint-target.rst b/Documentation/nvme/nvme-pci-endpoint-target.rst
> index 66e7b7d869b4..b699595d1762 100644
> --- a/Documentation/nvme/nvme-pci-endpoint-target.rst
> +++ b/Documentation/nvme/nvme-pci-endpoint-target.rst
> @@ -86,7 +86,7 @@ configurable through configfs before starting the controller. To avoid issues
>  with excessive local memory usage for executing commands, MDTS defaults to 512
>  KB and is limited to a maximum of 2 MB (arbitrary limit).
>  
> -Mimimum number of PCI Address Mapping Windows Required
> +Minimum number of PCI Address Mapping Windows Required
>  ------------------------------------------------------
>  
>  Most PCI endpoint controllers provide a limited number of mapping windows for
> diff --git a/Documentation/sound/soc/machine.rst b/Documentation/sound/soc/machine.rst
> index 9db132bc0070..1828f5edca3e 100644
> --- a/Documentation/sound/soc/machine.rst
> +++ b/Documentation/sound/soc/machine.rst
> @@ -75,7 +75,7 @@ In the above struct, dai’s are registered using names but you can pass
>  either dai name or device tree node but not both. Also, names used here
>  for cpu/codec/platform dais should be globally unique.
>  
> -Additionaly below example macro can be used to register cpu, codec and
> +Additionally below example macro can be used to register cpu, codec and
>  platform dai::
>  
>    SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
> diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
> index bf555c2270f5..1998dc146c56 100644
> --- a/Documentation/usb/gadget-testing.rst
> +++ b/Documentation/usb/gadget-testing.rst
> @@ -1050,7 +1050,7 @@ Its attributes are:
>  	midi1_num_groups	The number of groups for MIDI 1.0 (0-16)
>  	ui_hint			UI-hint of this FB
>  				0: unknown, 1: receiver, 2: sender, 3: both
> -	midi_ci_verison		Supported MIDI-CI version number (8 bit)
> +	midi_ci_version		Supported MIDI-CI version number (8 bit)
>  	is_midi1		Legacy MIDI 1.0 device (0-2)
>  				0: MIDI 2.0 device,
>  				1: MIDI 1.0 without restriction, or

-- 
~Randy

Re: [PATCH] Documentation: proofreading Documentation

[Jonathan Corbet]

Armin <armin.mahdilou@gmail.com> writes:

> Fixed some spelling issues in documentations.
>
> Signed-off-by: Armin <Armin.Mahdilou@gmail.com>

Could I please get a version of this with your full name in the SOB?
Otherwise the patch seems fine.

Thanks,

jon

[PATCH v2] Documentation: proofreading Documentation

[Armin Mahdilou]

Fixed some spelling issues in documentations.

Signed-off-by: Armin Mahdilou <Armin.Mahdilou@gmail.com>
---
Thanks the Ack and Review. This is my first patch for the kernel.
Fixed SOB.

Regards

 Documentation/ABI/testing/configfs-usb-gadget-midi2 | 2 +-
 Documentation/input/devices/elantech.rst            | 2 +-
 Documentation/nvme/nvme-pci-endpoint-target.rst     | 2 +-
 Documentation/sound/soc/machine.rst                 | 2 +-
 Documentation/usb/gadget-testing.rst                | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-midi2 b/Documentation/ABI/testing/configfs-usb-gadget-midi2
index 0eac3aaba137..d76a52e2ca7f 100644
--- a/Documentation/ABI/testing/configfs-usb-gadget-midi2
+++ b/Documentation/ABI/testing/configfs-usb-gadget-midi2
@@ -47,7 +47,7 @@ Description:
 		midi1_first_group	The first UMP Group number for MIDI 1.0 (0-15)
 		midi1_num_groups	The number of groups for MIDI 1.0 (0-16)
 		ui_hint			0: unknown, 1: receiver, 2: sender, 3: both
-		midi_ci_verison		Supported MIDI-CI version number (8 bit)
+		midi_ci_version		Supported MIDI-CI version number (8 bit)
 		is_midi1		Legacy MIDI 1.0 device (0, 1 or 2)
 		sysex8_streams		Max number of SysEx8 streams (8 bit)
 		active			Active FB flag (0 or 1)
diff --git a/Documentation/input/devices/elantech.rst b/Documentation/input/devices/elantech.rst
index c3374a7ce7af..98163a258b83 100644
--- a/Documentation/input/devices/elantech.rst
+++ b/Documentation/input/devices/elantech.rst
@@ -556,7 +556,7 @@ Note on debounce:
 In case the box has unstable power supply or other electricity issues, or
 when number of finger changes, F/W would send "debounce packet" to inform
 driver that the hardware is in debounce status.
-The debouce packet has the following signature::
+The debounce packet has the following signature::
 
     byte 0: 0xc4
     byte 1: 0xff
diff --git a/Documentation/nvme/nvme-pci-endpoint-target.rst b/Documentation/nvme/nvme-pci-endpoint-target.rst
index 66e7b7d869b4..b699595d1762 100644
--- a/Documentation/nvme/nvme-pci-endpoint-target.rst
+++ b/Documentation/nvme/nvme-pci-endpoint-target.rst
@@ -86,7 +86,7 @@ configurable through configfs before starting the controller. To avoid issues
 with excessive local memory usage for executing commands, MDTS defaults to 512
 KB and is limited to a maximum of 2 MB (arbitrary limit).
 
-Mimimum number of PCI Address Mapping Windows Required
+Minimum number of PCI Address Mapping Windows Required
 ------------------------------------------------------
 
 Most PCI endpoint controllers provide a limited number of mapping windows for
diff --git a/Documentation/sound/soc/machine.rst b/Documentation/sound/soc/machine.rst
index 9db132bc0070..1828f5edca3e 100644
--- a/Documentation/sound/soc/machine.rst
+++ b/Documentation/sound/soc/machine.rst
@@ -75,7 +75,7 @@ In the above struct, dai’s are registered using names but you can pass
 either dai name or device tree node but not both. Also, names used here
 for cpu/codec/platform dais should be globally unique.
 
-Additionaly below example macro can be used to register cpu, codec and
+Additionally below example macro can be used to register cpu, codec and
 platform dai::
 
   SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
index bf555c2270f5..1998dc146c56 100644
--- a/Documentation/usb/gadget-testing.rst
+++ b/Documentation/usb/gadget-testing.rst
@@ -1050,7 +1050,7 @@ Its attributes are:
 	midi1_num_groups	The number of groups for MIDI 1.0 (0-16)
 	ui_hint			UI-hint of this FB
 				0: unknown, 1: receiver, 2: sender, 3: both
-	midi_ci_verison		Supported MIDI-CI version number (8 bit)
+	midi_ci_version		Supported MIDI-CI version number (8 bit)
 	is_midi1		Legacy MIDI 1.0 device (0-2)
 				0: MIDI 2.0 device,
 				1: MIDI 1.0 without restriction, or
-- 
2.47.2

Re: [PATCH v2] Documentation: proofreading Documentation

[Armin Mahdilou]

On Mon, 2025-02-10 at 20:25 +0100, Armin Mahdilou wrote:
> Fixed some spelling issues in documentations.
> 
> Signed-off-by: Armin Mahdilou <Armin.Mahdilou@gmail.com>
Hi all,

Just a kind reminder about this patch.
I would like to know the status of it and as it's my first patch,
I want to know how can I track if it's merged or not.
Thanks in advance.

Regards,
Armin

Re: [PATCH v2] Documentation: proofreading Documentation

[Jonathan Corbet]

Armin Mahdilou <armin.mahdilou@gmail.com> writes:

> On Mon, 2025-02-10 at 20:25 +0100, Armin Mahdilou wrote:
>> Fixed some spelling issues in documentations.
>> 
>> Signed-off-by: Armin Mahdilou <Armin.Mahdilou@gmail.com>
> Hi all,
>
> Just a kind reminder about this patch.
> I would like to know the status of it and as it's my first patch,
> I want to know how can I track if it's merged or not.
> Thanks in advance.

It's in my queue, please be patient.

It would have been good for you to add Randy's ack when you reposted it;
I can fix that when I apply it.

Thanks,

jon

Re: [PATCH v2] Documentation: proofreading Documentation

[Jonathan Corbet]

Armin Mahdilou <armin.mahdilou@gmail.com> writes:

> Fixed some spelling issues in documentations.
>
> Signed-off-by: Armin Mahdilou <Armin.Mahdilou@gmail.com>
> ---
> Thanks the Ack and Review. This is my first patch for the kernel.
> Fixed SOB.
>
> Regards
>
>  Documentation/ABI/testing/configfs-usb-gadget-midi2 | 2 +-
>  Documentation/input/devices/elantech.rst            | 2 +-
>  Documentation/nvme/nvme-pci-endpoint-target.rst     | 2 +-
>  Documentation/sound/soc/machine.rst                 | 2 +-
>  Documentation/usb/gadget-testing.rst                | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)

Applied, thanks.

jon