Skip to contentSkip to conversation

docs: fix repeated prepositions across documentation

PATCH Superseded Adrien Reynard 5 participants 10 messages May 8 – May 9

Subsystems (6)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 4/5 docs: fix repeated prepositions across documentation

---
 Documentation/dev-tools/kasan.rst                   | 2 +-
 Documentation/networking/switchdev.rst              | 2 +-
 Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/dev-tools/kasan.rst +1 -1
index 4968b2aa60c8..3a8bd40ad905 100644
@@ -392,7 +392,7 @@ reserved to tag freed memory regions.
 If the hardware does not support MTE (pre ARMv8.5), Hardware Tag-Based KASAN
 will not be enabled. In this case, all KASAN boot parameters are ignored.
 
-Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being
+Note that enabling CONFIG_KASAN_HW_TAGS always results in-kernel TBI being
 enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not
 support MTE (but supports TBI).
 
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
 monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
 bond will see its upper master change.  If that bond is moved into a bridge,
 the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by
 registering for netdevice events and acting on NETDEV_CHANGEUPPER.
 
 L2 Forwarding Offload
Documentation/virt/uml/user_mode_linux_howto_v2.rst +1 -1
index c37e8e594d12..7b08738c30aa 100644
@@ -1092,7 +1092,7 @@ be formatted as plain text.
 
 Developing always goes hand in hand with debugging. First of all,
 you can always run UML under gdb and there will be a whole section
-later on on how to do that. That, however, is not the only way to
+later on how to do that. That, however, is not the only way to
 debug a Linux kernel. Quite often adding tracing statements and/or
 using UML specific approaches such as ptracing the UML kernel process
 are significantly more informative.
Signature · 1 line
2.54.0
reviewer Reviewed-by on v1 4/5
#1 lore raw

On 5/8/26 10:38, Adrien Reynard wrote:

Missing commit log

Quoted 12 lines
---
  Documentation/dev-tools/kasan.rst                   | 2 +-
  Documentation/networking/switchdev.rst              | 2 +-
  Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-
  3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/dev-tools/kasan.rst +0 -0
index 4968b2aa60c8..3a8bd40ad905 100644

Documentation/dev-tools/kasan.rst reserved to tag freed memory regions. · line 395

Quoted 5 lines
Documentation/dev-tools/kasan.rst +1 -1
@@ -392,7 +392,7 @@ reserved to tag freed memory regions.
  If the hardware does not support MTE (pre ARMv8.5), Hardware Tag-Based KASAN
  will not be enabled. In this case, all KASAN boot parameters are ignored.
 
-Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being
+Note that enabling CONFIG_KASAN_HW_TAGS always results in-kernel TBI being

This is correct the way it is - no need to change this. "results in in-kernel"

Documentation/networking/switchdev.rst The switchdev driver can know a particular port's position in the topology by · line 165

Quoted 13 lines
Documentation/dev-tools/kasan.rst +0 -0
  enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not
  support MTE (but supports TBI).
 
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
  monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
  bond will see its upper master change.  If that bond is moved into a bridge,
  the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by

This looks fine.

Documentation/virt/uml/user_mode_linux_howto_v2.rst be formatted as plain text. · line 1095

Quoted 13 lines
Documentation/networking/switchdev.rst +0 -0
  registering for netdevice events and acting on NETDEV_CHANGEUPPER.
 
  L2 Forwarding Offload
Documentation/virt/uml/user_mode_linux_howto_v2.rst +1 -1
index c37e8e594d12..7b08738c30aa 100644
@@ -1092,7 +1092,7 @@ be formatted as plain text.
 
  Developing always goes hand in hand with debugging. First of all,
  you can always run UML under gdb and there will be a whole section
-later on on how to do that. That, however, is not the only way to
+later on how to do that. That, however, is not the only way to

This change is not needed. If at all add a comma after "later" to make a distinction between the use two back to back "on"s

"later on,"

Documentation/virt/uml/user_mode_linux_howto_v2.rst be formatted as plain text. · line 1098

Quoted 3 lines
Documentation/virt/uml/user_mode_linux_howto_v2.rst +0 -0
  debug a Linux kernel. Quite often adding tracing statements and/or
  using UML specific approaches such as ptracing the UML kernel process
  are significantly more informative.

With these changes:

thanks,
-- Shuah

reviewer
#2 lore raw
Quoted 11 lines · Shuah Khan

On 5/8/26 10:38, Adrien Reynard wrote:

Missing commit log

Quoted 7 lines

---
  Documentation/dev-tools/kasan.rst                   | 2 +- Documentation/networking/switchdev.rst              | 2 +- Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-

  3 files changed, 3 insertions(+), 3 deletions(-)
Quoted 11 lines
Quoted 9 lines
Documentation/dev-tools/kasan.rst +0 -0
index 4968b2aa60c8..3a8bd40ad905 100644
@@ -392,7 +392,7 @@ reserved to tag freed memory regions.

  If the hardware does not support MTE (pre ARMv8.5), Hardware Tag-Based KASAN will not be enabled. In this case, all KASAN boot parameters are ignored. -Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being +Note that enabling CONFIG_KASAN_HW_TAGS always results in-kernel TBI being

This is correct the way it is - no need to change this. "results in in-kernel"

ack.

Quoted 6 lines
Quoted 6 lines

  enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not support MTE (but supports TBI).
  diff --git a/Documentation/networking/switchdev.rst b/Documentation/networking/switchdev.rst index 2966b7122f05..948bce44ca9b 100644

Documentation/networking/switchdev.rst +0 -0
Quoted 8 lines

Documentation/networking/switchdev.rst The switchdev driver can know a particular port's position in the topology by · line 165

Quoted 6 lines
Documentation/networking/switchdev.rst +0 -0
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by

  monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a bond will see its upper master change.  If that bond is moved into a bridge, the bond's upper master will change.  And so on.  The driver will track such

Documentation/networking/switchdev.rst +1 -1
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by

This looks fine.

Change not needed.

Quoted 15 lines

Documentation/virt/uml/user_mode_linux_howto_v2.rst be formatted as plain text. · line 1095

Quoted 11 lines

  registering for netdevice events and acting on NETDEV_CHANGEUPPER. L2 Forwarding Offload

Documentation/virt/uml/user_mode_linux_howto_v2.rst +0 -0
index c37e8e594d12..7b08738c30aa 100644
@@ -1092,7 +1092,7 @@ be formatted as plain text.
     Developing always goes hand in hand with debugging. First of all,

  you can always run UML under gdb and there will be a whole section

Documentation/virt/uml/user_mode_linux_howto_v2.rst +1 -1
-later on on how to do that. That, however, is not the only way to
+later on how to do that. That, however, is not the only way to

This change is not needed. If at all add a comma after "later" to make a distinction between the use two back to back "on"s

Quoted 1 line

 "later on,"

We disagree. :)
This change LGTM.

Signature · 1 line
~Randy
#3 lore raw
In reply to Shuah Khan
Quoted 23 lines · Shuah Khan

On 5/8/26 10:38, Adrien Reynard wrote:

Missing commit log

Quoted 12 lines
---
  Documentation/dev-tools/kasan.rst                   | 2 +-
  Documentation/networking/switchdev.rst              | 2 +-
  Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-
  3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/dev-tools/kasan.rst +0 -0
index 4968b2aa60c8..3a8bd40ad905 100644

Documentation/dev-tools/kasan.rst reserved to tag freed memory regions. · line 394

Quoted 4 lines
Documentation/dev-tools/kasan.rst +1 -1
@@ -392,7 +392,7 @@ reserved to tag freed memory regions.
  If the hardware does not support MTE (pre ARMv8.5), Hardware Tag-Based KASAN
  will not be enabled. In this case, all KASAN boot parameters are ignored.
-Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being
+Note that enabling CONFIG_KASAN_HW_TAGS always results in-kernel TBI being

This is correct the way it is - no need to change this. "results in in-kernel"

Quoted 14 lines

Documentation/networking/switchdev.rst The switchdev driver can know a particular port's position in the topology by · line 165

Quoted 12 lines
Documentation/dev-tools/kasan.rst +0 -0
  enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not
  support MTE (but supports TBI).
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
  monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
  bond will see its upper master change.  If that bond is moved into a bridge,
  the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by

This looks fine.

Fine as in the change is correct, or fine in that the original is correct and the change is wrong?

Because the change is wrong, there should be two in's here. Please search the archive for an explanation why.

This is the second time in a week i've had to deal with "improvements" like this actually breaking stuff. Which also shows that the submitter did not search to see if somebody has tried to fix this once already, and failed.

Can we get the tool changed to add a warning, something like:

WARNING: This tool uses very simple pattern matching to look for repeated words. It does not understand the complexity of English, and will often result in false positive reports. Please assume it is wrong until proven otherwise.

Andrew

reviewer
#4 lore raw
Quoted 50 lines · Andrew Lunn
Quoted 23 lines · Shuah Khan

On 5/8/26 10:38, Adrien Reynard wrote:

Missing commit log

Quoted 12 lines
---
  Documentation/dev-tools/kasan.rst                   | 2 +-
  Documentation/networking/switchdev.rst              | 2 +-
  Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-
  3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/dev-tools/kasan.rst +0 -0
index 4968b2aa60c8..3a8bd40ad905 100644

Documentation/dev-tools/kasan.rst reserved to tag freed memory regions. · line 394

Quoted 4 lines
Documentation/dev-tools/kasan.rst +1 -1
@@ -392,7 +392,7 @@ reserved to tag freed memory regions.
  If the hardware does not support MTE (pre ARMv8.5), Hardware Tag-Based KASAN
  will not be enabled. In this case, all KASAN boot parameters are ignored.
-Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being
+Note that enabling CONFIG_KASAN_HW_TAGS always results in-kernel TBI being

This is correct the way it is - no need to change this. "results in in-kernel"

Quoted 14 lines

Documentation/networking/switchdev.rst The switchdev driver can know a particular port's position in the topology by · line 165

Quoted 12 lines
Documentation/dev-tools/kasan.rst +0 -0
  enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not
  support MTE (but supports TBI).
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
  monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
  bond will see its upper master change.  If that bond is moved into a bridge,
  the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by

This looks fine.

Fine as in the change is correct, or fine in that the original is correct and the change is wrong?

Because the change is wrong, there should be two in's here. Please search the archive for an explanation why.

This is the second time in a week i've had to deal with "improvements" like this actually breaking stuff. Which also shows that the submitter did not search to see if somebody has tried to fix this once already, and failed.

Quoted 6 lines

Can we get the tool changed to add a warning, something like:

WARNING: This tool uses very simple pattern matching to look for repeated words. It does not understand the complexity of English, and will often result in false positive reports. Please assume it is wrong until proven otherwise.

There was no commit log and no cover letter AFAIK. Do we know what tool was used?

Adrien, how did you discover these repeated words?

(If it's my script from 2021, I'll gladly update it.)

Signature · 1 line
~Randy
#5 lore raw
Quoted 7 lines
Quoted 6 lines

Can we get the tool changed to add a warning, something like:

WARNING: This tool uses very simple pattern matching to look for repeated words. It does not understand the complexity of English, and will often result in false positive reports. Please assume it is wrong until proven otherwise.

Quoted 6 lines

There was no commit log and no cover letter AFAIK. Do we know what tool was used?

Adrien, how did you discover these repeated words?

(If it's my script from 2021, I'll gladly update it.)

Thinking about it some more, i think the warning might actually need to be different.

If this tool has been around since 2021, all the real problems have been solved, leaving only the false positives. So the warning probably needs to be much stronger, saying that it probably only reports false positives, unless the code is new.

Maybe we also want to extend the tool to have a list all the known false positives?

Andrew

reviewer
#6 lore raw
Quoted 7 lines · Andrew Lunn
Quoted 7 lines
Quoted 6 lines

Can we get the tool changed to add a warning, something like:

WARNING: This tool uses very simple pattern matching to look for repeated words. It does not understand the complexity of English, and will often result in false positive reports. Please assume it is wrong until proven otherwise.

Quoted 6 lines
Quoted 6 lines

There was no commit log and no cover letter AFAIK. Do we know what tool was used?

Adrien, how did you discover these repeated words?

(If it's my script from 2021, I'll gladly update it.)

Adrien is not using my script -- they developed their own script.

Quoted 7 lines

Thinking about it some more, i think the warning might actually need to be different.

If this tool has been around since 2021, all the real problems have been solved, leaving only the false positives. So the warning probably needs to be much stronger, saying that it probably only reports false positives, unless the code is new.

Makes some sense.

Quoted 2 lines

Maybe we also want to extend the tool to have a list all the known false positives?

I'm not crazy about that one. And we have no evidence that I am aware of that my script is causing any of these patches.

Signature · 1 line
~Randy
#7 lore raw
In reply to Adrien Reynard

On Fri, 8 May 2026 18:38:03 +0200
Adrien Reynard <[email protected]> wrote:

Nope, all these are correct as is.
I'm not looking at any more.

Quoted 46 lines
---
 Documentation/dev-tools/kasan.rst                   | 2 +-
 Documentation/networking/switchdev.rst              | 2 +-
 Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/dev-tools/kasan.rst +1 -1
index 4968b2aa60c8..3a8bd40ad905 100644
@@ -392,7 +392,7 @@ reserved to tag freed memory regions.
 If the hardware does not support MTE (pre ARMv8.5), Hardware Tag-Based KASAN
 will not be enabled. In this case, all KASAN boot parameters are ignored.
 
-Note that enabling CONFIG_KASAN_HW_TAGS always results in in-kernel TBI being
+Note that enabling CONFIG_KASAN_HW_TAGS always results in-kernel TBI being
 enabled. Even when ``kasan.mode=off`` is provided or when the hardware does not
 support MTE (but supports TBI).
 
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
 monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
 bond will see its upper master change.  If that bond is moved into a bridge,
 the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by
 registering for netdevice events and acting on NETDEV_CHANGEUPPER.
 
 L2 Forwarding Offload
Documentation/virt/uml/user_mode_linux_howto_v2.rst +1 -1
index c37e8e594d12..7b08738c30aa 100644
@@ -1092,7 +1092,7 @@ be formatted as plain text.
 
 Developing always goes hand in hand with debugging. First of all,
 you can always run UML under gdb and there will be a whole section
-later on on how to do that. That, however, is not the only way to
+later on how to do that. That, however, is not the only way to
 debug a Linux kernel. Quite often adding tracing statements and/or
 using UML specific approaches such as ptracing the UML kernel process
 are significantly more informative.
#8 lore raw

PATCH v2 4/4 docs: fix repeated word 'in' in networking documentation

In reply to Adrien Reynard

Remove duplicated word 'in' in networking/switchdev.rst.

---
 Documentation/networking/switchdev.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
 monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
 bond will see its upper master change.  If that bond is moved into a bridge,
 the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by
 registering for netdevice events and acting on NETDEV_CHANGEUPPER.
 
 L2 Forwarding Offload
Signature · 1 line
2.54.0
#9 lore raw

Re: [PATCH v2 4/4] docs: fix repeated word 'in' in networking documentation

Quoted 1 line · On Sat, 9 May 2026 16:31:03 +0200 Adrien Reynard…

Remove duplicated word 'in' in networking/switchdev.rst.

Nak

Quoted 19 lines
---
 Documentation/networking/switchdev.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/networking/switchdev.rst +1 -1
index 2966b7122f05..948bce44ca9b 100644
@@ -162,7 +162,7 @@ The switchdev driver can know a particular port's position in the topology by
 monitoring NETDEV_CHANGEUPPER notifications.  For example, a port moved into a
 bond will see its upper master change.  If that bond is moved into a bridge,
 the bond's upper master will change.  And so on.  The driver will track such
-movements to know what position a port is in in the overall topology by
+movements to know what position a port is in the overall topology by
 registering for netdevice events and acting on NETDEV_CHANGEUPPER.
 
 L2 Forwarding Offload