Skip to contentSkip to conversation

docs: fix repeated word 'that' across documentation

PATCH Superseded Adrien Reynard 7 participants 8 messages May 8 – May 9

Subsystems (6)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 2/5 docs: fix repeated word 'that' across documentation

---
 Documentation/RCU/rcu.rst                          | 2 +-
 Documentation/driver-api/driver-model/overview.rst | 2 +-
 Documentation/filesystems/netfs_library.rst        | 2 +-
 Documentation/trace/histogram-design.rst           | 2 +-
 Documentation/trace/histogram.rst                  | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
Documentation/RCU/rcu.rst +1 -1
index bf6617b330a7..320ad3292b75 100644
@@ -32,7 +32,7 @@ Frequently Asked Questions
   Just as with spinlocks, RCU readers are not permitted to
   block, switch to user-mode execution, or enter the idle loop.
   Therefore, as soon as a CPU is seen passing through any of these
-  three states, we know that that CPU has exited any previous RCU
+  three states, we know that CPU has exited any previous RCU
   read-side critical sections.  So, if we remove an item from a
   linked list, and then wait until all CPUs have switched context,
   executed in user mode, or executed in the idle loop, we can
Documentation/driver-api/driver-model/overview.rst +1 -1
index b3f447bf9f07..c1966d506d55 100644
@@ -55,7 +55,7 @@ struct pci_dev now looks like this::
 Note first that the struct device dev within the struct pci_dev is
 statically allocated. This means only one allocation on device discovery.
 
-Note also that that struct device dev is not necessarily defined at the
+Note also that struct device dev is not necessarily defined at the
 front of the pci_dev structure.  This is to make people think about what
 they're doing when switching between the bus driver and the global driver,
 and to discourage meaningless and incorrect casts between the two.
Documentation/filesystems/netfs_library.rst +1 -1
index ddd799df6ce3..4033de4535ac 100644
@@ -626,7 +626,7 @@ A number of members are available for access/use by the filesystem:
 
    These are set by the filesystem or the cache in ->prepare_read() or
    ->prepare_write() for each subrequest to indicate the maximum number of
-   bytes and, optionally, the maximum number of segments (if not 0) that that
+   bytes and, optionally, the maximum number of segments (if not 0) that
    subrequest can support.
 
  * ``submit_extendable_to``
Documentation/trace/histogram-design.rst +1 -1
index e92f56ebd0b5..949bbfdb0f16 100644
@@ -738,7 +738,7 @@ creates its own variable, wakeup_lat, but nothing yet uses it::
 
 Looking at the sched_waking 'hist_debug' output, in addition to the
 normal key and value hist_fields, in the val fields section we see a
-field with the HIST_FIELD_FL_VAR flag, which indicates that that field
+field with the HIST_FIELD_FL_VAR flag, which indicates that field
 represents a variable.  Note that in addition to the variable name,
 contained in the var.name field, it includes the var.idx, which is the
 index into the tracing_map_elt.vars[] array of the actual variable
Documentation/trace/histogram.rst +1 -1
index 340bcb5099e7..5b303fabdf32 100644
@@ -1700,7 +1700,7 @@ to that rule is that any variable used in an expression is essentially
 'read-once' - once it's used by an expression in a subsequent event,
 it's reset to its 'unset' state, which means it can't be used again
 unless it's set again.  This ensures not only that an event doesn't
-use an uninitialized variable in a calculation, but that that variable
+use an uninitialized variable in a calculation, but that variable
 is used only once and not for any unrelated subsequent match.
 
 The basic syntax for saving a variable is to simply prefix a unique
Signature · 1 line
2.54.0
reviewer
#1 lore raw

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

Missing commit log in all your patches - I don't patch 1/5 in my Inbox.

Quoted 14 lines
---
  Documentation/RCU/rcu.rst                          | 2 +-
  Documentation/driver-api/driver-model/overview.rst | 2 +-
  Documentation/filesystems/netfs_library.rst        | 2 +-
  Documentation/trace/histogram-design.rst           | 2 +-
  Documentation/trace/histogram.rst                  | 2 +-
  5 files changed, 5 insertions(+), 5 deletions(-)
Documentation/RCU/rcu.rst +0 -0
index bf6617b330a7..320ad3292b75 100644

Documentation/RCU/rcu.rst Frequently Asked Questions · line 35

Quoted 5 lines
Documentation/RCU/rcu.rst +1 -1
@@ -32,7 +32,7 @@ Frequently Asked Questions
    Just as with spinlocks, RCU readers are not permitted to
    block, switch to user-mode execution, or enter the idle loop.
    Therefore, as soon as a CPU is seen passing through any of these
-  three states, we know that that CPU has exited any previous RCU
+  three states, we know that CPU has exited any previous RCU

The original intent might have been to say, "that cpu", so adding the missing comma after the first "that" or change "that" to "the" would make sense.

Documentation/driver-api/driver-model/overview.rst struct pci_dev now looks like this:: · line 58

Quoted 13 lines
Documentation/RCU/rcu.rst +0 -0
    read-side critical sections.  So, if we remove an item from a
    linked list, and then wait until all CPUs have switched context,
    executed in user mode, or executed in the idle loop, we can
Documentation/driver-api/driver-model/overview.rst +1 -1
index b3f447bf9f07..c1966d506d55 100644
@@ -55,7 +55,7 @@ struct pci_dev now looks like this::
  Note first that the struct device dev within the struct pci_dev is
  statically allocated. This means only one allocation on device discovery.
 
-Note also that that struct device dev is not necessarily defined at the
+Note also that struct device dev is not necessarily defined at the

Sam comment here, replace "that" with "the" or add missing comma

Documentation/filesystems/netfs_library.rst A number of members are available for access/use by the filesystem: · line 629

Quoted 13 lines
Documentation/driver-api/driver-model/overview.rst +0 -0
  front of the pci_dev structure.  This is to make people think about what
  they're doing when switching between the bus driver and the global driver,
  and to discourage meaningless and incorrect casts between the two.
Documentation/filesystems/netfs_library.rst +1 -1
index ddd799df6ce3..4033de4535ac 100644
@@ -626,7 +626,7 @@ A number of members are available for access/use by the filesystem:
 
     These are set by the filesystem or the cache in ->prepare_read() or
     ->prepare_write() for each subrequest to indicate the maximum number of
-   bytes and, optionally, the maximum number of segments (if not 0) that that
+   bytes and, optionally, the maximum number of segments (if not 0) that

Same here.

Documentation/trace/histogram-design.rst creates its own variable, wakeup_lat, but nothing yet uses it:: · line 741

Quoted 13 lines
Documentation/filesystems/netfs_library.rst +0 -0
     subrequest can support.
 
   * ``submit_extendable_to``
Documentation/trace/histogram-design.rst +1 -1
index e92f56ebd0b5..949bbfdb0f16 100644
@@ -738,7 +738,7 @@ creates its own variable, wakeup_lat, but nothing yet uses it::
 
  Looking at the sched_waking 'hist_debug' output, in addition to the
  normal key and value hist_fields, in the val fields section we see a
-field with the HIST_FIELD_FL_VAR flag, which indicates that that field
+field with the HIST_FIELD_FL_VAR flag, which indicates that field

Same here

Documentation/trace/histogram.rst to that rule is that any variable used in an expression is essentially · line 1703

Quoted 13 lines
Documentation/trace/histogram-design.rst +0 -0
  represents a variable.  Note that in addition to the variable name,
  contained in the var.name field, it includes the var.idx, which is the
  index into the tracing_map_elt.vars[] array of the actual variable
Documentation/trace/histogram.rst +1 -1
index 340bcb5099e7..5b303fabdf32 100644
@@ -1700,7 +1700,7 @@ to that rule is that any variable used in an expression is essentially
  'read-once' - once it's used by an expression in a subsequent event,
  it's reset to its 'unset' state, which means it can't be used again
  unless it's set again.  This ensures not only that an event doesn't
-use an uninitialized variable in a calculation, but that that variable
+use an uninitialized variable in a calculation, but that variable

Same here

Documentation/trace/histogram.rst to that rule is that any variable used in an expression is essentially · line 1706

Quoted 3 lines
Documentation/trace/histogram.rst +0 -0
  is used only once and not for any unrelated subsequent match.
 
  The basic syntax for saving a variable is to simply prefix a unique

thanks,
-- Shuah

reviewer
#2 lore raw
Quoted 14 lines · Shuah Khan

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

Missing commit log in all your patches - I don't patch 1/5 in my Inbox.

Quoted 9 lines

---
  Documentation/RCU/rcu.rst                          | 2 +- Documentation/driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/netfs_library.rst        | 2 +- Documentation/trace/histogram-design.rst           | 2 +- Documentation/trace/histogram.rst                  | 2 +-

  5 files changed, 5 insertions(+), 5 deletions(-)
Quoted 14 lines
Quoted 10 lines
Documentation/RCU/rcu.rst +0 -0
index bf6617b330a7..320ad3292b75 100644
@@ -32,7 +32,7 @@ Frequently Asked Questions

    Just as with spinlocks, RCU readers are not permitted to block, switch to user-mode execution, or enter the idle loop. Therefore, as soon as a CPU is seen passing through any of these -  three states, we know that that CPU has exited any previous RCU +  three states, we know that CPU has exited any previous RCU

The original intent might have been to say, "that cpu", so adding the missing comma after the first "that" or change "that" to "the" would make sense.

Not a comma, please.
I don't see a problem with "that that," but "that the" could also be OK.

Quoted 5 lines
Quoted 5 lines

    read-side critical sections.  So, if we remove an item from a linked list, and then wait until all CPUs have switched context, executed in user mode, or executed in the idle loop, we can

Signature · 1 line
~Randy
maintainer
#3 lore raw
Quoted 32 lines · Randy Dunlap
Quoted 14 lines · Shuah Khan

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

Missing commit log in all your patches - I don't patch 1/5 in my Inbox.

Quoted 9 lines

---
  Documentation/RCU/rcu.rst                          | 2 +- Documentation/driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/netfs_library.rst        | 2 +- Documentation/trace/histogram-design.rst           | 2 +- Documentation/trace/histogram.rst                  | 2 +-

  5 files changed, 5 insertions(+), 5 deletions(-)
Quoted 14 lines
Quoted 10 lines
Documentation/RCU/rcu.rst +0 -0
index bf6617b330a7..320ad3292b75 100644
@@ -32,7 +32,7 @@ Frequently Asked Questions

    Just as with spinlocks, RCU readers are not permitted to block, switch to user-mode execution, or enter the idle loop. Therefore, as soon as a CPU is seen passing through any of these -  three states, we know that that CPU has exited any previous RCU +  three states, we know that CPU has exited any previous RCU

The original intent might have been to say, "that cpu", so adding the missing comma after the first "that" or change "that" to "the" would make sense.

Quoted 2 lines

Not a comma, please.
I don't see a problem with "that that," but "that the" could also be OK.

This CPU was already mentioned. So if for whatever reason we cannnot stomach "that that", then "that this" would be better than "that the".

I suppose that false positives from simple grammar checkers might be sufficient reason, but in this brave new world of LLMs, shouldn't we be hoping for better? ;-)

Thanx, Paul

Quoted 8 lines
Quoted 3 lines
Quoted 3 lines

    read-side critical sections.  So, if we remove an item from a linked list, and then wait until all CPUs have switched context, executed in user mode, or executed in the idle loop, we can

Signature · 1 line
~Randy
#4 lore raw
In reply to Shuah Khan
Quoted 14 lines · On Fri, 8 May 2026 11:15:28 -0600 Shuah Khan <[email protected]> wrote:

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

Missing commit log in all your patches - I don't patch 1/5 in my Inbox.

Quoted 9 lines
---
  Documentation/RCU/rcu.rst                          | 2 +-
  Documentation/driver-api/driver-model/overview.rst | 2 +-
  Documentation/filesystems/netfs_library.rst        | 2 +-
  Documentation/trace/histogram-design.rst           | 2 +-
  Documentation/trace/histogram.rst                  | 2 +-
  5 files changed, 5 insertions(+), 5 deletions(-)
Quoted 14 lines

Documentation/RCU/rcu.rst Frequently Asked Questions · line 35

Quoted 10 lines
Documentation/RCU/rcu.rst +1 -1
index bf6617b330a7..320ad3292b75 100644
@@ -32,7 +32,7 @@ Frequently Asked Questions
    Just as with spinlocks, RCU readers are not permitted to
    block, switch to user-mode execution, or enter the idle loop.
    Therefore, as soon as a CPU is seen passing through any of these
-  three states, we know that that CPU has exited any previous RCU
+  three states, we know that CPU has exited any previous RCU  

The original intent might have been to say, "that cpu", so adding the missing comma after the first "that" or change "that" to "the" would make sense.

...

I don't think adding a comma would be correct.
The clause splits as 'we know that' 'that CPU' and the repeated 'that' is absolutely correct.
Maybe 'that CPU' could be replaced by 'it'; but it can be difficult to work out what back references like 'it' refer to.

You can re-order it, as (say):
Therefore we know that as soon as a CPU is seen passing through any of these three states it has exited any previous RCU read-side critical sections.

But just because some grammar book says you shouldn't have repeated words doesn't mean there aren't exceptions.

The sign writer was doing a new sign for the 'Pig and Whistle'. Unfortunately the gaps between Pig and and and and and Whistle ended up visibly different.

-- David

maintainer
#5 lore raw
In reply to Adrien Reynard
Quoted 1 line · Adrien Reynard

- three states, we know that that CPU has exited any previous RCU

This is arguably correct. The two 'that' words are functionally different. If you look at another language, say Hungarian, they are different words (e.g. 'hogy' vs 'az').

David

#6 lore raw

PATCH v2 2/4 docs: fix repeated word 'that' across documentation

In reply to Adrien Reynard

Remove duplicated word 'that' found in RCU/rcu.rst, driver-api/driver-model/overview.rst, filesystems/netfs_library.rst, trace/histogram-design.rst and trace/histogram.rst.

---
 Documentation/RCU/rcu.rst                          | 2 +-
 Documentation/driver-api/driver-model/overview.rst | 2 +-
 Documentation/filesystems/netfs_library.rst        | 2 +-
 Documentation/trace/histogram-design.rst           | 2 +-
 Documentation/trace/histogram.rst                  | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
Documentation/RCU/rcu.rst +1 -1
index bf6617b330a7..110f3d42cace 100644
@@ -32,7 +32,7 @@ Frequently Asked Questions
   Just as with spinlocks, RCU readers are not permitted to
   block, switch to user-mode execution, or enter the idle loop.
   Therefore, as soon as a CPU is seen passing through any of these
-  three states, we know that that CPU has exited any previous RCU
+  three states, we know that the CPU has exited any previous RCU
   read-side critical sections.  So, if we remove an item from a
   linked list, and then wait until all CPUs have switched context,
   executed in user mode, or executed in the idle loop, we can
Documentation/driver-api/driver-model/overview.rst +1 -1
index b3f447bf9f07..4360cd5200be 100644
@@ -55,7 +55,7 @@ struct pci_dev now looks like this::
 Note first that the struct device dev within the struct pci_dev is
 statically allocated. This means only one allocation on device discovery.
 
-Note also that that struct device dev is not necessarily defined at the
+Note also that the struct device dev is not necessarily defined at the
 front of the pci_dev structure.  This is to make people think about what
 they're doing when switching between the bus driver and the global driver,
 and to discourage meaningless and incorrect casts between the two.
Documentation/filesystems/netfs_library.rst +1 -1
index ddd799df6ce3..715218e1b233 100644
@@ -626,7 +626,7 @@ A number of members are available for access/use by the filesystem:
 
    These are set by the filesystem or the cache in ->prepare_read() or
    ->prepare_write() for each subrequest to indicate the maximum number of
-   bytes and, optionally, the maximum number of segments (if not 0) that that
+   bytes and, optionally, the maximum number of segments (if not 0) that the
    subrequest can support.
 
  * ``submit_extendable_to``
Documentation/trace/histogram-design.rst +1 -1
index e92f56ebd0b5..c25587f411f2 100644
@@ -738,7 +738,7 @@ creates its own variable, wakeup_lat, but nothing yet uses it::
 
 Looking at the sched_waking 'hist_debug' output, in addition to the
 normal key and value hist_fields, in the val fields section we see a
-field with the HIST_FIELD_FL_VAR flag, which indicates that that field
+field with the HIST_FIELD_FL_VAR flag, which indicates that the field
 represents a variable.  Note that in addition to the variable name,
 contained in the var.name field, it includes the var.idx, which is the
 index into the tracing_map_elt.vars[] array of the actual variable
Documentation/trace/histogram.rst +1 -1
index 340bcb5099e7..ca619499ce28 100644
@@ -1700,7 +1700,7 @@ to that rule is that any variable used in an expression is essentially
 'read-once' - once it's used by an expression in a subsequent event,
 it's reset to its 'unset' state, which means it can't be used again
 unless it's set again.  This ensures not only that an event doesn't
-use an uninitialized variable in a calculation, but that that variable
+use an uninitialized variable in a calculation, but that the variable
 is used only once and not for any unrelated subsequent match.
 
 The basic syntax for saving a variable is to simply prefix a unique
Signature · 1 line
2.54.0
maintainer
#7 lore raw
Quoted 5 lines · Adrien Reynard

Remove duplicated word 'that' found in RCU/rcu.rst, driver-api/driver-model/overview.rst, filesystems/netfs_library.rst, trace/histogram-design.rst and trace/histogram.rst.

Quoted 8 lines
---
 Documentation/RCU/rcu.rst                          | 2 +-
 Documentation/driver-api/driver-model/overview.rst | 2 +-
 Documentation/filesystems/netfs_library.rst        | 2 +-
 Documentation/trace/histogram-design.rst           | 2 +-
 Documentation/trace/histogram.rst                  | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

When you send an updated version of a patch, please:

- Post it as its own thread, rather than as a response to a previous version

- Include a note after the "---" line explaining the changes from the previous version.

Thanks,

jon