Correcting the spelling mistakes in "Documentation/ABI/testing/sysfs-bus-cxl" and "Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc"

Message ID 20240220214212.10231-1-pvkumar5749404@gmail.com
State New
Headers
Series Correcting the spelling mistakes in "Documentation/ABI/testing/sysfs-bus-cxl" and "Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc" |

Commit Message

prabhav kumar Feb. 20, 2024, 9:42 p.m. UTC
  Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>

Changes:
	- "avaialble" corrected to "available" in "Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc"
	- "firwmare" corrected to "firmware" in "Documentation/ABI/testing/sysfs-bus-cxl"
Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>
---
 Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc | 2 +-
 Documentation/ABI/testing/sysfs-bus-cxl                   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
  

Comments

Suzuki K Poulose Feb. 26, 2024, 3:55 p.m. UTC | #1
Hi Prabhav,


On 20/02/2024 21:42, Prabhav Kumar Vaish wrote:

Thanks for sending the patch. Please find some comments.

> Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>

Only one "Signed-off-by:" tag is required, the second one below
is at the desired location. So, please drop the above.


> 
> Changes:
> 	- "avaialble" corrected to "available" in "Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc"
> 	- "firwmare" corrected to "firmware" in "Documentation/ABI/testing/sysfs-bus-cxl"

It is advisable to split this patch into two, as they affect files
maintained by different subsystems. i.e., coresight and CXL. Since
they go via different maintainers, it is always better to split
the patch (especially when there is no functional dependency, like
this case).

Also, I see that you haven't copied any of the maintainers for the CXL 
subsystem. Running "scripts/get_maintainer.pl" on the affected file
or the patch should give you the email addresses for the concerned
maintainers/list.

e.g:

$ scripts/get_maintainer.pl Documentation/ABI/testing/sysfs-bus-cxl

So, please resend the patch after splitting, to the respective 
maintainers/reviewers/list.

Suzuki

> Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>
> ---
>   Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc | 2 +-
>   Documentation/ABI/testing/sysfs-bus-cxl                   | 2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
> index 96aafa66b4a5..339cec3b2f1a 100644
> --- a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
> @@ -97,7 +97,7 @@ Date:		August 2023
>   KernelVersion:	6.7
>   Contact:	Anshuman Khandual <anshuman.khandual@arm.com>
>   Description:	(Read) Shows all supported Coresight TMC-ETR buffer modes available
> -		for the users to configure explicitly. This file is avaialble only
> +		for the users to configure explicitly. This file is available only
>   		for TMC ETR devices.
>   
>   What:		/sys/bus/coresight/devices/<memory_map>.tmc/buf_mode_preferred
> diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> index fff2581b8033..bbf6de5a4ca1 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cxl
> +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> @@ -224,7 +224,7 @@ Description:
>   		decoding a Host Physical Address range. Note that this number
>   		may be elevated without any regionX objects active or even
>   		enumerated, as this may be due to decoders established by
> -		platform firwmare or a previous kernel (kexec).
> +		platform firmware or a previous kernel (kexec).
>   
>   
>   What:		/sys/bus/cxl/devices/decoderX.Y
  
Suzuki K Poulose Feb. 26, 2024, 5:12 p.m. UTC | #2
On 21/02/2024 18:52, prabhav kumar wrote:
> 
> 
> On Wed, Feb 21, 2024 at 3:12 AM Prabhav Kumar Vaish 
> <pvkumar5749404@gmail.com <mailto:pvkumar5749404@gmail.com>> wrote:
> 
>     Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com
>     <mailto:pvkumar5749404@gmail.com>>
> 
>     Changes:
>              - "avaialble" corrected to "available" in
>     "Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc"
>              - "firwmare" corrected to "firmware" in
>     "Documentation/ABI/testing/sysfs-bus-cxl"
>     Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com
>     <mailto:pvkumar5749404@gmail.com>>

And also, please don't post empty responses. + Fix your mail client to
stick to plain-text for email responses on the list.


Suzuki


>     ---
>       Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc | 2 +-
>       Documentation/ABI/testing/sysfs-bus-cxl                   | 2 +-
>       2 files changed, 2 insertions(+), 2 deletions(-)
> 
>     diff --git
>     a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>     b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>     index 96aafa66b4a5..339cec3b2f1a 100644
>     --- a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>     +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>     @@ -97,7 +97,7 @@ Date:         August 2023
>       KernelVersion: 6.7
>       Contact:       Anshuman Khandual <anshuman.khandual@arm.com
>     <mailto:anshuman.khandual@arm.com>>
>       Description:   (Read) Shows all supported Coresight TMC-ETR buffer
>     modes available
>     -               for the users to configure explicitly. This file is
>     avaialble only
>     +               for the users to configure explicitly. This file is
>     available only
>                      for TMC ETR devices.
> 
>       What:         
>     /sys/bus/coresight/devices/<memory_map>.tmc/buf_mode_preferred
>     diff --git a/Documentation/ABI/testing/sysfs-bus-cxl
>     b/Documentation/ABI/testing/sysfs-bus-cxl
>     index fff2581b8033..bbf6de5a4ca1 100644
>     --- a/Documentation/ABI/testing/sysfs-bus-cxl
>     +++ b/Documentation/ABI/testing/sysfs-bus-cxl
>     @@ -224,7 +224,7 @@ Description:
>                      decoding a Host Physical Address range. Note that
>     this number
>                      may be elevated without any regionX objects active
>     or even
>                      enumerated, as this may be due to decoders
>     established by
>     -               platform firwmare or a previous kernel (kexec).
>     +               platform firmware or a previous kernel (kexec).
> 
> 
>       What:          /sys/bus/cxl/devices/decoderX.Y
>     -- 
>     2.34.1
>
  
Suzuki K Poulose Feb. 27, 2024, 11:17 a.m. UTC | #3
On 26/02/2024 18:58, prabhav kumar wrote:
> Thanks for commenting on the patch.
> 
> Will generate another patch for corresponding subsystem.
> I had ran the get_maintainer script on the CXL subsystem , but didn't 
> get any maintainer's name other than the commit_signers

Another nit: Please do not top post your replies. Use inline replies.

https://en.wikipedia.org/wiki/Posting_style#Interleaved_style


Suzuki
> 
> Thanks,
> Prabhav
> 
> On Mon, Feb 26, 2024 at 9:25 PM Suzuki K Poulose <suzuki.poulose@arm.com 
> <mailto:suzuki.poulose@arm.com>> wrote:
> 
>     Hi Prabhav,
> 
> 
>     On 20/02/2024 21:42, Prabhav Kumar Vaish wrote:
> 
>     Thanks for sending the patch. Please find some comments.
> 
>      > Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com
>     <mailto:pvkumar5749404@gmail.com>>
> 
>     Only one "Signed-off-by:" tag is required, the second one below
>     is at the desired location. So, please drop the above.
> 
> 
>      >
>      > Changes:
>      >       - "avaialble" corrected to "available" in
>     "Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc"
>      >       - "firwmare" corrected to "firmware" in
>     "Documentation/ABI/testing/sysfs-bus-cxl"
> 
>     It is advisable to split this patch into two, as they affect files
>     maintained by different subsystems. i.e., coresight and CXL. Since
>     they go via different maintainers, it is always better to split
>     the patch (especially when there is no functional dependency, like
>     this case).
> 
>     Also, I see that you haven't copied any of the maintainers for the CXL
>     subsystem. Running "scripts/get_maintainer.pl
>     <http://get_maintainer.pl>" on the affected file
>     or the patch should give you the email addresses for the concerned
>     maintainers/list.
> 
>     e.g:
> 
>     $ scripts/get_maintainer.pl <http://get_maintainer.pl>
>     Documentation/ABI/testing/sysfs-bus-cxl
> 
>     So, please resend the patch after splitting, to the respective
>     maintainers/reviewers/list.
> 
>     Suzuki
> 
>      > Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com
>     <mailto:pvkumar5749404@gmail.com>>
>      > ---
>      >   Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc | 2 +-
>      >   Documentation/ABI/testing/sysfs-bus-cxl                   | 2 +-
>      >   2 files changed, 2 insertions(+), 2 deletions(-)
>      >
>      > diff --git
>     a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>     b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>      > index 96aafa66b4a5..339cec3b2f1a 100644
>      > --- a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>      > +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
>      > @@ -97,7 +97,7 @@ Date:               August 2023
>      >   KernelVersion:      6.7
>      >   Contact:    Anshuman Khandual <anshuman.khandual@arm.com
>     <mailto:anshuman.khandual@arm.com>>
>      >   Description:        (Read) Shows all supported Coresight
>     TMC-ETR buffer modes available
>      > -             for the users to configure explicitly. This file is
>     avaialble only
>      > +             for the users to configure explicitly. This file is
>     available only
>      >               for TMC ETR devices.
>      >
>      >   What:             
>       /sys/bus/coresight/devices/<memory_map>.tmc/buf_mode_preferred
>      > diff --git a/Documentation/ABI/testing/sysfs-bus-cxl
>     b/Documentation/ABI/testing/sysfs-bus-cxl
>      > index fff2581b8033..bbf6de5a4ca1 100644
>      > --- a/Documentation/ABI/testing/sysfs-bus-cxl
>      > +++ b/Documentation/ABI/testing/sysfs-bus-cxl
>      > @@ -224,7 +224,7 @@ Description:
>      >               decoding a Host Physical Address range. Note that
>     this number
>      >               may be elevated without any regionX objects active
>     or even
>      >               enumerated, as this may be due to decoders
>     established by
>      > -             platform firwmare or a previous kernel (kexec).
>      > +             platform firmware or a previous kernel (kexec).
>      >
>      >
>      >   What:               /sys/bus/cxl/devices/decoderX.Y
>
  

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
index 96aafa66b4a5..339cec3b2f1a 100644
--- a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
+++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
@@ -97,7 +97,7 @@  Date:		August 2023
 KernelVersion:	6.7
 Contact:	Anshuman Khandual <anshuman.khandual@arm.com>
 Description:	(Read) Shows all supported Coresight TMC-ETR buffer modes available
-		for the users to configure explicitly. This file is avaialble only
+		for the users to configure explicitly. This file is available only
 		for TMC ETR devices.
 
 What:		/sys/bus/coresight/devices/<memory_map>.tmc/buf_mode_preferred
diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
index fff2581b8033..bbf6de5a4ca1 100644
--- a/Documentation/ABI/testing/sysfs-bus-cxl
+++ b/Documentation/ABI/testing/sysfs-bus-cxl
@@ -224,7 +224,7 @@  Description:
 		decoding a Host Physical Address range. Note that this number
 		may be elevated without any regionX objects active or even
 		enumerated, as this may be due to decoders established by
-		platform firwmare or a previous kernel (kexec).
+		platform firmware or a previous kernel (kexec).
 
 
 What:		/sys/bus/cxl/devices/decoderX.Y