Skip to contentSkip to conversation

Remove duplicate words inside documentation

PATCH In review Akhil Raj 3 participants 3 messages Aug 27, 2022 – Aug 29, 2022

Subsystems (6)
lore
Share & tools
lore

Akhil Raj

author
#0 lore raw

PATCH 1/1 Remove duplicate words inside documentation

I have removed repeated the inside the documentation

---
 Documentation/admin-guide/kdump/vmcoreinfo.rst    | 2 +-
 Documentation/bpf/map_cgroup_storage.rst          | 4 ++--
 Documentation/core-api/cpu_hotplug.rst            | 2 +-
 Documentation/driver-api/isa.rst                  | 2 +-
 Documentation/filesystems/caching/backend-api.rst | 2 +-
 Documentation/locking/seqlock.rst                 | 2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)
Documentation/admin-guide/kdump/vmcoreinfo.rst +1 -1
index 8419019b6a88..6726f439958c 100644
@@ -200,7 +200,7 @@ prb
 
 A pointer to the printk ringbuffer (struct printk_ringbuffer). This
 may be pointing to the static boot ringbuffer or the dynamically
-allocated ringbuffer, depending on when the the core dump occurred.
+allocated ringbuffer, depending on when the core dump occurred.
 Used by user-space tools to read the active kernel log buffer.
 
 printk_rb_static
Documentation/bpf/map_cgroup_storage.rst +2 -2
index cab9543017bf..8e5fe532c07e 100644
@@ -31,7 +31,7 @@ The map uses key of type of either ``__u64 cgroup_inode_id`` or
     };
 
 ``cgroup_inode_id`` is the inode id of the cgroup directory.
-``attach_type`` is the the program's attach type.
+``attach_type`` is the program's attach type.
 
 Linux 5.9 added support for type ``__u64 cgroup_inode_id`` as the key type.
 When this key type is used, then all attach types of the particular cgroup and
@@ -155,7 +155,7 @@ However, the BPF program can still only associate with one map of each type
 ``BPF_MAP_TYPE_CGROUP_STORAGE`` or more than one
 ``BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE``.
 
-In all versions, userspace may use the the attach parameters of cgroup and
+In all versions, userspace may use the attach parameters of cgroup and
 attach type pair in ``struct bpf_cgroup_storage_key`` as the key to the BPF map
 APIs to read or update the storage for a given attachment. For Linux 5.9
 attach type shared storages, only the first value in the struct, cgroup inode
Documentation/core-api/cpu_hotplug.rst +1 -1
index c6f4ba2fb32d..f75778d37488 100644
@@ -560,7 +560,7 @@ available:
   * cpuhp_state_remove_instance(state, node)
   * cpuhp_state_remove_instance_nocalls(state, node)
 
-The arguments are the same as for the the cpuhp_state_add_instance*()
+The arguments are the same as for the cpuhp_state_add_instance*()
 variants above.
 
 The functions differ in the way how the installed callbacks are treated:
Documentation/driver-api/isa.rst +1 -1
index def4a7b690b5..3df1b1696524 100644
@@ -100,7 +100,7 @@ I believe platform_data is available for this, but if rather not, moving
 the isa_driver pointer to the private struct isa_dev is ofcourse fine as
 well.
 
-Then, if the the driver did not provide a .match, it matches. If it did,
+Then, if the driver did not provide a .match, it matches. If it did,
 the driver match() method is called to determine a match.
 
 If it did **not** match, dev->platform_data is reset to indicate this to
Documentation/filesystems/caching/backend-api.rst +1 -1
index d7507becf674..3a199fc50828 100644
@@ -122,7 +122,7 @@ volumes, calling::
 to tell fscache that a volume has been withdrawn.  This waits for all
 outstanding accesses on the volume to complete before returning.
 
-When the the cache is completely withdrawn, fscache should be notified by
+When the cache is completely withdrawn, fscache should be notified by
 calling::
 
 	void fscache_relinquish_cache(struct fscache_cache *cache);
Documentation/locking/seqlock.rst +1 -1
index 64405e5da63e..bfda1a5fecad 100644
@@ -39,7 +39,7 @@ as the writer can invalidate a pointer that the reader is following.
 Sequence counters (``seqcount_t``)
 ==================================
 
-This is the the raw counting mechanism, which does not protect against
+This is the raw counting mechanism, which does not protect against
 multiple writers.  Write side critical sections must thus be serialized
 by an external lock.
 
Signature · 1 line
2.17.1
reviewer
#1 lore raw

Hi--

Quoted 11 lines · Akhil Raj

I have removed repeated the inside the documentation

---
 Documentation/admin-guide/kdump/vmcoreinfo.rst    | 2 +-
 Documentation/bpf/map_cgroup_storage.rst          | 4 ++--
 Documentation/core-api/cpu_hotplug.rst            | 2 +-
 Documentation/driver-api/isa.rst                  | 2 +-
 Documentation/filesystems/caching/backend-api.rst | 2 +-
 Documentation/locking/seqlock.rst                 | 2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)

Looks good, although parts of it seem to be duplicates of another similar patch.
https://lore.kernel.org/linux-doc/[email protected]/T/#me8fa863e9f8c00fbbf4d11af8412c3bd8df5cfc5

And there are duplicated words other that "the" that could be cleaned up.
E.g.:
we trace guest of when and should to in send that is on as can at this are

Signature · 1 line
~Randy
maintainer
#2 lore raw
In reply to Akhil Raj
Quoted 11 lines · Akhil Raj

I have removed repeated the inside the documentation

---
 Documentation/admin-guide/kdump/vmcoreinfo.rst    | 2 +-
 Documentation/bpf/map_cgroup_storage.rst          | 4 ++--
 Documentation/core-api/cpu_hotplug.rst            | 2 +-
 Documentation/driver-api/isa.rst                  | 2 +-
 Documentation/filesystems/caching/backend-api.rst | 2 +-
 Documentation/locking/seqlock.rst                 | 2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)

Patch applied.

If I'm not mistaken, this is your first accepted kernel patch - congratulations!

Thanks,

jon