Skip to contentSkip to conversation

staging: unisys: Documentation: Fix for longline and typo in doc

PATCH In review R Veera Kumar 2 participants 4 messages Mar 14, 2020 – Mar 18, 2020 Staging

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: unisys: Documentation: Fix for longline and typo in doc

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

---
 drivers/staging/unisys/Documentation/overview.txt | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
drivers/staging/unisys/Documentation/overview.txt +7 -7
index f8a4144b239c..7f0427cafca9 100644
@@ -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
Signature · 1 line
2.20.1
#1 lore raw

drivers/staging/unisys/Documentation/overview.txt NOT covered in this document: · line 59

Quoted 11 lines · On Sat, 14 Mar 2020 11:01:51 +0530 R Veera Kumar <[email protected]> wrote:

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

[...]

drivers/staging/unisys/Documentation/overview.txt +1 -1
@@ -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.

Signature · 1 line
Stefano
#2 lore raw
Quoted 12 lines · Stefano Brivio
Quoted 9 lines · On Sat, 14 Mar 2020 11:01:51 +0530 R Veera Kumar <[email protected]> wrote:

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

[...]

drivers/staging/unisys/Documentation/overview.txt +0 -0
@@ -56,7 +56,7 @@ NOT covered in this document:
 2.1.1. Overview
 ---------------
 
Quoted 8 lines

drivers/staging/unisys/Documentation/overview.txt NOT covered in this document: · line 59

Quoted 2 lines
drivers/staging/unisys/Documentation/overview.txt +1 -1
-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.

Quoted 2 lines

Please re-send.

Sent it.

Veera

Quoted 3 lines
Signature · 1 line
Stefano
#3 lore raw
Quoted 22 lines · On Wed, 18 Mar 2020 06:03:27 +0530 R Veera Kumar <[email protected]> wrote:
Quoted 12 lines · Stefano Brivio
Quoted 9 lines · On Sat, 14 Mar 2020 11:01:51 +0530 R Veera Kumar <[email protected]> wrote:

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

[...]

drivers/staging/unisys/Documentation/overview.txt +0 -0
@@ -56,7 +56,7 @@ NOT covered in this document:
 2.1.1. Overview
 ---------------
 
Quoted 8 lines

drivers/staging/unisys/Documentation/overview.txt NOT covered in this document: · line 59

Quoted 2 lines
drivers/staging/unisys/Documentation/overview.txt +1 -1
-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.

Quoted 2 lines

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.

Quoted 1 line

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".

Signature · 1 line
Stefano