docs: fix typos and duplicated words across documentation
Subsystems (3)
PATCH 1/1 docs: fix typos and duplicated words across documentation
Fix the following typos and duplicated words:
- admin-guide/pm/intel-speed-select.rst: "weather" -> "whether"
- core-api/real-time/differences.rst: "the the" -> "the"
- admin-guide/bcache.rst: "to to" -> "to"
- networking/switchdev.rst: "is in in" -> "is in"
--- Documentation/admin-guide/bcache.rst | 2 +- Documentation/admin-guide/pm/intel-speed-select.rst | 2 +- Documentation/core-api/real-time/differences.rst | 2 +- Documentation/networking/switchdev.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)
Documentation/admin-guide/bcache.rst +1 -1
@@ -618,7 +618,7 @@ cache_replacement_policy One of either lru, fifo or random. freelist_percent - Size of the freelist as a percentage of nbuckets. Can be written to to + Size of the freelist as a percentage of nbuckets. Can be written to increase the number of buckets kept on the freelist, which lets you artificially reduce the size of the cache at runtime. Mostly for testing purposes (i.e. testing how different size caches affect your hit rate).
Documentation/admin-guide/pm/intel-speed-select.rst +1 -1
@@ -287,7 +287,7 @@ level. Check presence of other Intel(R) SST features --------------------------------------------- -Each of the performance profiles also specifies weather there is support of +Each of the performance profiles also specifies whether there is support of other two Intel(R) SST features (Intel(R) Speed Select Technology - Base Frequency (Intel(R) SST-BF) and Intel(R) Speed Select Technology - Turbo Frequency (Intel SST-TF)).
Documentation/core-api/real-time/differences.rst +1 -1
@@ -213,7 +213,7 @@ to suspend until the callback completes, ensuring forward progress without risking livelock. In order to solve the problem at the API level, the sequence locks were extended -to allow a proper handover between the the spinning reader and the maybe +to allow a proper handover between the spinning reader and the maybe blocked writer. Sequence locks
Documentation/networking/switchdev.rst +1 -1
@@ -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.51.0
Randy Dunlap
reviewerHi,
Quoted 46 lines · Manuel Cortez
Fix the following typos and duplicated words:
-
admin-guide/pm/intel-speed-select.rst: "weather" -> "whether"
-core-api/real-time/differences.rst: "the the" -> "the"
-admin-guide/bcache.rst: "to to" -> "to"
-networking/switchdev.rst: "is in in" -> "is in"Signed-off-by Manuel Cortez <[email protected]>--- Documentation/admin-guide/bcache.rst | 2 +- Documentation/admin-guide/pm/intel-speed-select.rst | 2 +- Documentation/core-api/real-time/differences.rst | 2 +- Documentation/networking/switchdev.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)Documentation/admin-guide/bcache.rst +1
-1@@ -618,7 +618,7 @@ cache_replacement_policy One of either lru, fifo or random. freelist_percent - Size of the freelist as a percentage of nbuckets. Can be written to to + Size of the freelist as a percentage of nbuckets. Can be written to increase the number of buckets kept on the freelist, which lets you artificially reduce the size of the cache at runtime. Mostly for testing purposes (i.e. testing how different size caches affect your hit rate).Documentation/admin-guide/pm/intel-speed-select.rst +1
-1@@ -287,7 +287,7 @@ level. Check presence of other Intel(R) SST features --------------------------------------------- -Each of the performance profiles also specifies weather there is support of +Each of the performance profiles also specifies whether there is support of other two Intel(R) SST features (Intel(R) Speed Select Technology - Base Frequency (Intel(R) SST-BF) and Intel(R) Speed Select Technology - Turbo Frequency (Intel SST-TF)).Documentation/core-api/real-time/differences.rst +0
-0
Documentation/core-api/real-time/differences.rst to suspend until the callback completes, ensuring forward progress without · line 219
Quoted 8 lines
Documentation/core-api/real-time/differences.rst +1
-1@@ -213,7 +213,7 @@ to suspend until the callback completes, ensuring forward progress without risking livelock. In order to solve the problem at the API level, the sequence locks were extended -to allow a proper handover between the the spinning reader and the maybe +to allow a proper handover between the spinning reader and the maybe blocked writer. Sequence locks
Those first 3 look good.
Just a matter of how they get merged.
This last one is a little awkward as is but dropping one "in" doesn't help it -- it harms it (i.e., it's correct as is but could possibly be improved.)
Quoted 13 lines
Documentation/networking/switchdev.rst +1
-1@@ -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
~Randy
Quoted 5 lines · Randy Dunlap
Hi,
This last one is a little awkward as is but dropping one "in" doesn't help it -- it harms it (i.e., it's correct as is but could possibly be improved.)
Quoted 10 lines
Documentation/networking/switchdev.rst The switchdev driver can know a particular port's position in the topology by · line 165
Quoted 10 lines
Documentation/networking/switchdev.rst +1
-1@@ -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
I think it can be reworded as "The driver will track movements to locate the port's position in the overall topology ...".
Thanks.
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH v2 1/1 docs: fix typos and duplicated words across documentation
In reply to Manuel CortezFix the following typos and duplicated words:
- admin-guide/pm/intel-speed-select.rst: "weather" -> "whether"
- core-api/real-time/differences.rst: "the the" -> "the"
- admin-guide/bcache.rst: "to to" -> "to"
---
Changes in v2:
- Dropped the networking/switchdev.rst change as "is in in" is correct per Randy Dunlap's review.
Documentation/admin-guide/bcache.rst | 2 +- Documentation/admin-guide/pm/intel-speed-select.rst | 2 +- Documentation/core-api/real-time/differences.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/admin-guide/bcache.rst +1 -1
@@ -618,7 +618,7 @@ cache_replacement_policy One of either lru, fifo or random. freelist_percent - Size of the freelist as a percentage of nbuckets. Can be written to to + Size of the freelist as a percentage of nbuckets. Can be written to increase the number of buckets kept on the freelist, which lets you artificially reduce the size of the cache at runtime. Mostly for testing purposes (i.e. testing how different size caches affect your hit rate).
Documentation/admin-guide/pm/intel-speed-select.rst +1 -1
@@ -287,7 +287,7 @@ level. Check presence of other Intel(R) SST features --------------------------------------------- -Each of the performance profiles also specifies weather there is support of +Each of the performance profiles also specifies whether there is support of other two Intel(R) SST features (Intel(R) Speed Select Technology - Base Frequency (Intel(R) SST-BF) and Intel(R) Speed Select Technology - Turbo Frequency (Intel SST-TF)).
Documentation/core-api/real-time/differences.rst +1 -1
@@ -213,7 +213,7 @@ to suspend until the callback completes, ensuring forward progress without risking livelock. In order to solve the problem at the API level, the sequence locks were extended -to allow a proper handover between the the spinning reader and the maybe +to allow a proper handover between the spinning reader and the maybe blocked writer. Sequence locks
Signature · 1 line
2.51.0
Quoted 7 lines · Manuel Cortez
Fix the following typos and duplicated words:
-
admin-guide/pm/intel-speed-select.rst: "weather" -> "whether"
-core-api/real-time/differences.rst: "the the" -> "the"
-admin-guide/bcache.rst: "to to" -> "to"Signed-off-by Manuel Cortez <[email protected]>
Quoted 49 lines
---
Changes in v2:
- Dropped thenetworking/switchdev.rstchange as "is in in" is correct per Randy Dunlap's review.Documentation/admin-guide/bcache.rst | 2 +- Documentation/admin-guide/pm/intel-speed-select.rst | 2 +- Documentation/core-api/real-time/differences.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)Documentation/admin-guide/bcache.rst +1
-1@@ -618,7 +618,7 @@ cache_replacement_policy One of either lru, fifo or random. freelist_percent - Size of the freelist as a percentage of nbuckets. Can be written to to + Size of the freelist as a percentage of nbuckets. Can be written to increase the number of buckets kept on the freelist, which lets you artificially reduce the size of the cache at runtime. Mostly for testing purposes (i.e. testing how different size caches affect your hit rate).Documentation/admin-guide/pm/intel-speed-select.rst +1
-1@@ -287,7 +287,7 @@ level. Check presence of other Intel(R) SST features --------------------------------------------- -Each of the performance profiles also specifies weather there is support of +Each of the performance profiles also specifies whether there is support of other two Intel(R) SST features (Intel(R) Speed Select Technology - Base Frequency (Intel(R) SST-BF) and Intel(R) Speed Select Technology - Turbo Frequency (Intel SST-TF)).Documentation/core-api/real-time/differences.rst +1
-1@@ -213,7 +213,7 @@ to suspend until the callback completes, ensuring forward progress without risking livelock. In order to solve the problem at the API level, the sequence locks were extended -to allow a proper handover between the the spinning reader and the maybe +to allow a proper handover between the spinning reader and the maybe blocked writer. Sequence locks
Signature · 1 line
~Randy
Quoted 12 lines · Manuel Cortez
Fix the following typos and duplicated words:
-
admin-guide/pm/intel-speed-select.rst: "weather" -> "whether"
-core-api/real-time/differences.rst: "the the" -> "the"
-admin-guide/bcache.rst: "to to" -> "to"Signed-off-by Manuel Cortez <[email protected]>---
Changes in v2:
- Dropped thenetworking/switchdev.rstchange as "is in in" is correct per Randy Dunlap's review.
Quoted 4 lines
Documentation/admin-guide/bcache.rst | 2 +- Documentation/admin-guide/pm/intel-speed-select.rst | 2 +- Documentation/core-api/real-time/differences.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)
Applied, thanks.
jon