[PATCH] staging: unisys: Documentation: Fix for longline and typo in doc

[PATCH] staging: unisys: Documentation: Fix for longline and typo in doc

[R Veera Kumar]

Fix longline and a typo in documentation.
Found using checkpatch.pl.

Signed-off-by: R Veera Kumar <vkor@vkten.in>
---
 drivers/staging/unisys/Documentation/overview.txt | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/staging/unisys/Documentation/overview.txt b/drivers/staging/unisys/Documentation/overview.txt
index f8a4144b239c..7f0427cafca9 100644
--- a/drivers/staging/unisys/Documentation/overview.txt
+++ b/drivers/staging/unisys/Documentation/overview.txt
@@ -15,12 +15,12 @@ normally be unsharable, specifically:
 * visorinput - keyboard and mouse
 
 These drivers conform to the standard Linux bus/device model described
-within Documentation/driver-api/driver-model/, and utilize a driver named visorbus to
-present the virtual busses involved. Drivers in the 'visor*' driver set are
-commonly referred to as "guest drivers" or "client drivers".  All drivers
-except visorbus expose a device of a specific usable class to the Linux guest
-environment (e.g., block, network, or input), and are collectively referred
-to as "function drivers".
+within Documentation/driver-api/driver-model/, and utilize a driver named
+visorbus to present the virtual busses involved. Drivers in the 'visor*'
+driver set are commonly referred to as "guest drivers" or "client drivers".
+All drivers except visorbus expose a device of a specific usable class to the
+Linux guest environment (e.g., block, network, or input), and are collectively
+referred to as "function drivers".
 
 The back-end for each device is owned and managed by a small,
 single-purpose service partition in the s-Par firmware, which communicates
@@ -56,7 +56,7 @@ NOT covered in this document:
 2.1.1. Overview
 ---------------
 
-The visorbus driver handles the virtual busses on which all of the virtual
+The visorbus driver handles the virtual buses on which all of the virtual
 devices reside. It provides a registration function named
 visorbus_register_visor_driver() that is called by each of the function
 drivers at initialization time, which the function driver uses to tell
-- 
2.20.1

Re: [Outreachy kernel] [PATCH] staging: unisys: Documentation: Fix for longline and typo in doc

[Stefano Brivio]

On Sat, 14 Mar 2020 11:01:51 +0530
R Veera Kumar <vkor@vkten.in> wrote:

> Fix longline and a typo in documentation.
> Found using checkpatch.pl.
> 
> [...]
>
> @@ -56,7 +56,7 @@ NOT covered in this document:
>  2.1.1. Overview
>  ---------------
>  
> -The visorbus driver handles the virtual busses on which all of the virtual
> +The visorbus driver handles the virtual buses on which all of the virtual

This is not a typo, both spellings are correct and you are anyway
keeping a "busses" in the other section. We also
have drivers/i2c/busses/. If checkpatch is reporting this, I think it
should be fixed.

Please re-send.

-- 
Stefano

Re: [Outreachy kernel] [PATCH] staging: unisys: Documentation: Fix for longline and typo in doc

[R Veera Kumar]

On Tue, Mar 17, 2020 at 11:00:44AM +0100, Stefano Brivio wrote:
> On Sat, 14 Mar 2020 11:01:51 +0530
> R Veera Kumar <vkor@vkten.in> wrote:
> 
> > Fix longline and a typo in documentation.
> > Found using checkpatch.pl.
> > 
> > [...]
> >
> > @@ -56,7 +56,7 @@ NOT covered in this document:
> >  2.1.1. Overview
> >  ---------------
> >  
> > -The visorbus driver handles the virtual busses on which all of the virtual
> > +The visorbus driver handles the virtual buses on which all of the virtual
> 
> This is not a typo, both spellings are correct and you are anyway
> keeping a "busses" in the other section. We also
> have drivers/i2c/busses/. If checkpatch is reporting this, I think it
> should be fixed.
> 

English US spells busses.
English Uk spells buses.


The dictionary database used by checkpatch.pl, codespell is the problem.

> Please re-send.
> 

Sent it.

Veera

> -- 
> Stefano
> 

Re: [Outreachy kernel] [PATCH] staging: unisys: Documentation: Fix for longline and typo in doc

[Stefano Brivio]

On Wed, 18 Mar 2020 06:03:27 +0530
R Veera Kumar <vkor@vkten.in> wrote:

> On Tue, Mar 17, 2020 at 11:00:44AM +0100, Stefano Brivio wrote:
> > On Sat, 14 Mar 2020 11:01:51 +0530
> > R Veera Kumar <vkor@vkten.in> wrote:
> >   
> > > Fix longline and a typo in documentation.
> > > Found using checkpatch.pl.
> > > 
> > > [...]
> > >
> > > @@ -56,7 +56,7 @@ NOT covered in this document:
> > >  2.1.1. Overview
> > >  ---------------
> > >  
> > > -The visorbus driver handles the virtual busses on which all of the virtual
> > > +The visorbus driver handles the virtual buses on which all of the virtual  
> > 
> > This is not a typo, both spellings are correct and you are anyway
> > keeping a "busses" in the other section. We also
> > have drivers/i2c/busses/. If checkpatch is reporting this, I think it
> > should be fixed.
> >   
> 
> English US spells busses.
> English Uk spells buses.

Buses is nowadays the prevalent spelling also in AmE:
	https://www.merriam-webster.com/words-at-play/plural-of-bus

but that doesn't make the other spelling a typo.

> The dictionary database used by checkpatch.pl, codespell is the problem.

I have two observations:

- codespell is open source

- you are supposed to check what tools do, otherwise tools would be
  able to do that by themselves. Indeed, I'm assuming you were tricked
  by it, and that's understandable -- but that doesn't necessarily make
  them "the problem".

-- 
Stefano