docs: fix spelling mistakes across multiple directories
Subsystems (11)
v2 cover docs: fix spelling mistakes across multiple directories
Used codespell to detect spelling mistakes across multiple directories and fixed various simple typos found after manually filtering out the abbreviations, names, and non-english words.
These changes were split by subsystem as requested during review of v1.
---
Specific changes:
Quoted 2 lines
deivces -> devices
substracting -> subtracting
in Documentation/ABI/testing/sysfs-fs-f2fs
Quoted 2 lines
conventioanl -> conventional
directoy -> directory
in Documentation/admin-guide/blockdev/zoned_loop.rst
Quoted 1 line
Availablity -> Availability
in Documentation/admin-guide/cgroup-v2.rst
Quoted 2 lines
flushs -> flushes
explicitely -> explicitly
in Documentation/admin-guide/device-mapper/delay.rst
Quoted 1 line
approriate -> appropriate
in Documentation/admin-guide/device-mapper/vdo-design.rst
Quoted 1 line
aproximate -> approximate
in Documentation/admin-guide/laptops/alienware-wmi.rst
Quoted 1 line
directores -> directories
in Documentation/admin-guide/mm/damon/usage.rst
Quoted 1 line
multipled -> multiplied
in Documentation/mm/damon/design.rst.
Quoted 1 line
entension -> extension
in Documentation/arch/loongarch/irq-chip-model.rst
Quoted 1 line
userpace -> userspace
in Documentation/admin-guide/tainted-kernels.rst
Quoted 1 line
whoes -> whose
in Documentation/core-api/symbol-namespaces.rst
---
Changes since v1:
- Split into multiple patches per subsystem
- Adjusted heading underline lengths where necessary to avoid build warnings
---
Soham Metha (9):
docs: f2fs: fixed spelling mistakes in documentation
docs: zoned_loop: fixed spelling mistakes in documentation
docs: cgroup: fixed spelling mistakes in documentation
docs: device-mapper: fixed spelling mistakes in documentation
docs: alienware-wmi: fixed spelling mistake in admin guide
docs: damon: fixed spelling mistakes in documentation
docs: loongarch: fixed spelling mistake in documentation
docs: admin-guide: tainted-kernels: fixed spelling mistake in
documentation
docs: symbol-namespaces: fixed spelling mistake in documentation
Documentation/ABI/testing/sysfs-fs-f2fs | 6 +++--- Documentation/admin-guide/blockdev/zoned_loop.rst | 4 ++-- Documentation/admin-guide/cgroup-v2.rst | 4 ++-- Documentation/admin-guide/device-mapper/delay.rst | 8 ++++---- Documentation/admin-guide/device-mapper/vdo-design.rst | 2 +- Documentation/admin-guide/laptops/alienware-wmi.rst | 2 +- Documentation/admin-guide/mm/damon/usage.rst | 2 +- Documentation/admin-guide/tainted-kernels.rst | 2 +- Documentation/arch/loongarch/irq-chip-model.rst | 2 +- Documentation/core-api/symbol-namespaces.rst | 2 +- Documentation/mm/damon/design.rst | 2 +- 11 files changed, 18 insertions(+), 18 deletions(-)
Signature · 1 line
2.34.1
PATCH v2 1/9 docs: f2fs: fixed spelling mistakes in documentation
found/fixed the following typos
- deivces -> devices
- substracting -> subtracting
in Documentation/ABI/testing/sysfs-fs-f2fs
--- Documentation/ABI/testing/sysfs-fs-f2fs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-fs-f2fs +3 -3
@@ -822,8 +822,8 @@ What: /sys/fs/f2fs/<disk>/gc_valid_thresh_ratio Date: September 2024 Contact: "Daeho Jeong" <[email protected]> Description: It controls the valid block ratio threshold not to trigger excessive GC - for zoned deivces. The initial value of it is 95(%). F2FS will stop the - background GC thread from intiating GC for sections having valid blocks + for zoned devices. The initial value of it is 95(%). F2FS will stop the + background GC thread from initiating GC for sections having valid blocks exceeding the ratio. What: /sys/fs/f2fs/<disk>/max_read_extent_count
@@ -847,7 +847,7 @@ Description: For several zoned storage devices, vendors will provide extra space filesystem level GC. To do that, we can reserve the space using reserved_blocks. However, it is not enough, since this extra space should not be shown to users. So, with this new sysfs node, we can hide the space - by substracting reserved_blocks from total bytes. + by subtracting reserved_blocks from total bytes. What: /sys/fs/f2fs/<disk>/encoding_flags Date: April 2025
Signature · 1 line
2.34.1
Re: [PATCH v2 1/9] docs: f2fs: fixed spelling mistakes in documentation
Quoted 8 lines · Soham Metha
found/fixed the following typos
- deivces -> devices
- substracting -> subtractingin
Documentation/ABI/testing/sysfs-fs-f2fsSigned-off-by Soham Metha <[email protected]>
Thanks,
PATCH v2 3/9 docs: cgroup: fixed spelling mistakes in documentation
In reply to Soham Methafound/fixed the following typo
- Availablity -> Availability
in Documentation/admin-guide/cgroup-v2.rst
--- Documentation/admin-guide/cgroup-v2.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/cgroup-v2.rst +2 -2
@@ -435,8 +435,8 @@ both cgroups. Controlling Controllers ----------------------- -Availablity -~~~~~~~~~~~ +Availability +~~~~~~~~~~~~ A controller is available in a cgroup when it is supported by the kernel (i.e., compiled in, not disabled and not attached to a v1 hierarchy) and listed in the
Signature · 1 line
2.34.1
PATCH v2 4/9 docs: device-mapper: fixed spelling mistakes in documentation
found/fixed the following typos
- flushs -> flushes
- explicitely -> explicitly
in Documentation/admin-guide/device-mapper/delay.rst, and
- approriate -> appropriate
in Documentation/admin-guide/device-mapper/vdo-design.rst
--- Documentation/admin-guide/device-mapper/delay.rst | 8 ++++---- Documentation/admin-guide/device-mapper/vdo-design.rst | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-)
Documentation/admin-guide/device-mapper/delay.rst +4 -4
@@ -3,7 +3,7 @@ dm-delay ======== Device-Mapper's "delay" target delays reads and/or writes -and/or flushs and optionally maps them to different devices. +and/or flushes and optionally maps them to different devices. Arguments::
@@ -18,7 +18,7 @@ Table line has to either have 3, 6 or 9 arguments: to write and flush operations on optionally different write_device with optionally different sector offset -9: same as 6 arguments plus define flush_offset and flush_delay explicitely +9: same as 6 arguments plus define flush_offset and flush_delay explicitly on/with optionally different flush_device/flush_offset. Offsets are specified in sectors.
@@ -40,7 +40,7 @@ Example scripts #!/bin/sh # # Create mapped device delaying write and flush operations for 400ms and - # splitting reads to device $1 but writes and flushs to different device $2 + # splitting reads to device $1 but writes and flushes to different device $2 # to different offsets of 2048 and 4096 sectors respectively. # dmsetup create delayed --table "0 `blockdev --getsz $1` delay $1 2048 0 $2 4096 400"
@@ -48,7 +48,7 @@ Example scripts :: #!/bin/sh # - # Create mapped device delaying reads for 50ms, writes for 100ms and flushs for 333ms + # Create mapped device delaying reads for 50ms, writes for 100ms and flushes for 333ms # onto the same backing device at offset 0 sectors. # dmsetup create delayed --table "0 `blockdev --getsz $1` delay $1 0 50 $2 0 100 $1 0 333"
Documentation/admin-guide/device-mapper/vdo-design.rst +1 -1
@@ -600,7 +600,7 @@ lock and return itself to the pool. All storage within vdo is managed as 4KB blocks, but it can accept writes as small as 512 bytes. Processing a write that is smaller than 4K requires a read-modify-write operation that reads the relevant 4K block, copies the -new data over the approriate sectors of the block, and then launches a +new data over the appropriate sectors of the block, and then launches a write operation for the modified data block. The read and write stages of this operation are nearly identical to the normal read and write operations, and a single data_vio is used throughout this operation.
Signature · 1 line
2.34.1
Re: [PATCH v2 4/9] docs: device-mapper: fixed spelling mistakes in documentation
Applied, thanks.
Mikulas
Quoted 73 lines · Soham Metha
found/fixed the following typos
- flushs -> flushes
- explicitely -> explicitlyin
Documentation/admin-guide/device-mapper/delay.rst, and- approriate -> appropriate
in
Documentation/admin-guide/device-mapper/vdo-design.rstSigned-off-by Soham Metha <[email protected]>--- Documentation/admin-guide/device-mapper/delay.rst | 8 ++++---- Documentation/admin-guide/device-mapper/vdo-design.rst | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-)Documentation/admin-guide/device-mapper/delay.rst +4
-4@@ -3,7 +3,7 @@ dm-delay ======== Device-Mapper's "delay" target delays reads and/or writes -and/or flushs and optionally maps them to different devices. +and/or flushes and optionally maps them to different devices. Arguments::@@ -18,7 +18,7 @@ Table line has to either have 3, 6 or 9 arguments: to write and flush operations on optionally different write_device with optionally different sector offset -9: same as 6 arguments plus define flush_offset and flush_delay explicitely +9: same as 6 arguments plus define flush_offset and flush_delay explicitly on/with optionally different flush_device/flush_offset. Offsets are specified in sectors.@@ -40,7 +40,7 @@ Example scripts #!/bin/sh # # Create mapped device delaying write and flush operations for 400ms and - # splitting reads to device $1 but writes and flushs to different device $2 + # splitting reads to device $1 but writes and flushes to different device $2 # to different offsets of 2048 and 4096 sectors respectively. # dmsetup create delayed --table "0 `blockdev --getsz $1` delay $1 2048 0 $2 4096 400"@@ -48,7 +48,7 @@ Example scripts :: #!/bin/sh # - # Create mapped device delaying reads for 50ms, writes for 100ms and flushs for 333ms + # Create mapped device delaying reads for 50ms, writes for 100ms and flushes for 333ms # onto the same backing device at offset 0 sectors. # dmsetup create delayed --table "0 `blockdev --getsz $1` delay $1 0 50 $2 0 100 $1 0 333"Documentation/admin-guide/device-mapper/vdo-design.rst +1
-1@@ -600,7 +600,7 @@ lock and return itself to the pool. All storage within vdo is managed as 4KB blocks, but it can accept writes as small as 512 bytes. Processing a write that is smaller than 4K requires a read-modify-write operation that reads the relevant 4K block, copies the -new data over the approriate sectors of the block, and then launches a +new data over the appropriate sectors of the block, and then launches a write operation for the modified data block. The read and write stages of this operation are nearly identical to the normal read and write operations, and a single data_vio is used throughout this operation.Signature · 1 line
2.34.1
PATCH v2 5/9 docs: alienware-wmi: fixed spelling mistake in admin guide
In reply to Soham Methafound/fixed the following typo
- aproximate -> approximate
in Documentation/admin-guide/laptops/alienware-wmi.rst
--- Documentation/admin-guide/laptops/alienware-wmi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/laptops/alienware-wmi.rst +1 -1
@@ -105,7 +105,7 @@ information. Manual fan control on the other hand, is not exposed directly by the AWCC interface. Instead it let's us control a fan `boost` value. This `boost` value -has the following aproximate behavior over the fan pwm: +has the following approximate behavior over the fan pwm: ::
Signature · 1 line
2.34.1
Re: [PATCH v2 5/9] docs: alienware-wmi: fixed spelling mistake in admin guide
Hi Soham,
Quoted 3 lines · Soham Metha
found/fixed the following typo
- aproximate -> approximate
Thanks!
Quoted 4 lines
in
Documentation/admin-guide/laptops/alienware-wmi.rstSigned-off-by Soham Metha <[email protected]>
Please, Cc this to the appropriate subsystem and maintainers. You can check MAINTAINERS or use ./scripts/get_maintainer.pl.
After that is addressed:
Quoted 17 lines
--- Documentation/admin-guide/laptops/alienware-wmi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/admin-guide/laptops/alienware-wmi.rst +1
-1@@ -105,7 +105,7 @@ information. Manual fan control on the other hand, is not exposed directly by the AWCC interface. Instead it let's us control a fan `boost` value. This `boost` value -has the following aproximate behavior over the fan pwm: +has the following approximate behavior over the fan pwm: ::
Signature · 1 line
~ Kurt
A message that is not in the archive (sent off-list or not yet received): [email protected]
A message that is not in the archive (sent off-list or not yet received): [email protected]
Soham Metha
Reviewed-by Kurt BorjaRe: [PATCH v2 5/9] docs: alienware-wmi: fixed spelling mistake in admin guide
found/fixed the following typo
- aproximate -> approximate
in Documentation/admin-guide/laptops/alienware-wmi.rst
---
Quoted 10 lines
You are missing mailing lists:
- [email protected]
- [email protected]And platform-drivers-x86 subsystem maintainers:
- Ilpo Järvinen <[email protected]>
- Hans de Goede <[email protected]>
Thanks for the clarification. I have added the missing mailing lists and subsystem maintainers as suggested.
---
Documentation/admin-guide/laptops/alienware-wmi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/laptops/alienware-wmi.rst +1 -1
@@ -105,7 +105,7 @@ information. Manual fan control on the other hand, is not exposed directly by the AWCC interface. Instead it let's us control a fan `boost` value. This `boost` value -has the following aproximate behavior over the fan pwm: +has the following approximate behavior over the fan pwm:
Re: [PATCH v2 3/9] docs: cgroup: fixed spelling mistakes in documentation
In reply to Soham MethaQuoted 7 lines · Soham Metha
found/fixed the following typo
- Availablity -> Availability
in
Documentation/admin-guide/cgroup-v2.rstSigned-off-by Soham Metha <[email protected]>
Applied to cgroup/for-6.17-fixes.
Thanks.
Signature · 1 line
tejun
PATCH v2 6/9 docs: damon: fixed spelling mistakes in documentation
In reply to Soham Methafound/fixed the following typos
- directores -> directories
in Documentation/admin-guide/mm/damon/usage.rst, and
- multipled -> multiplied
in Documentation/mm/damon/design.rst.
--- Documentation/admin-guide/mm/damon/usage.rst | 2 +- Documentation/mm/damon/design.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/mm/damon/usage.rst +1 -1
@@ -357,7 +357,7 @@ The directory for the :ref:`quotas <damon_design_damos_quotas>` of the given DAMON-based operation scheme. Under ``quotas`` directory, four files (``ms``, ``bytes``, -``reset_interval_ms``, ``effective_bytes``) and two directores (``weights`` and +``reset_interval_ms``, ``effective_bytes``) and two directories (``weights`` and ``goals``) exist. You can set the ``time quota`` in milliseconds, ``size quota`` in bytes, and
Documentation/mm/damon/design.rst +1 -1
@@ -364,7 +364,7 @@ The tuning is turned off by default, and need to be set explicitly by the user. As a rule of thumbs and the Parreto principle, 4% access samples ratio target is recommended. Note that Parreto principle (80/20 rule) has applied twice. That is, assumes 4% (20% of 20%) DAMON-observed access events ratio (source) -to capture 64% (80% multipled by 80%) real access events (outcomes). +to capture 64% (80% multiplied by 80%) real access events (outcomes). To know how user-space can use this feature via :ref:`DAMON sysfs interface <sysfs_interface>`, refer to :ref:`intervals_goal <sysfs_scheme>` part of
Signature · 1 line
2.34.1
Re: [PATCH v2 6/9] docs: damon: fixed spelling mistakes in documentation
Quoted 11 lines · On Wed, 13 Aug 2025 02:19:49 +0530 Soham Metha <[email protected]> wrote:
found/fixed the following typos
- directores -> directories
in
Documentation/admin-guide/mm/damon/usage.rst, and- multipled -> multiplied
in
Documentation/mm/damon/design.rst.Signed-off-by Soham Metha <[email protected]>
Thank you for finding and fixing this!
Thanks,
SJ
[...]
PATCH v2 7/9 docs: loongarch: fixed spelling mistake in documentation
In reply to Soham Methafound/fixed the following typo
- entension -> extension
in Documentation/arch/loongarch/irq-chip-model.rst
--- Documentation/arch/loongarch/irq-chip-model.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/arch/loongarch/irq-chip-model.rst +1 -1
@@ -139,7 +139,7 @@ Feature EXTIOI_HAS_INT_ENCODE is part of standard EIOINTC. If it is 1, it indicates that CPU Interrupt Pin selection can be normal method rather than bitmap method, so interrupt can be routed to IP0 - IP15. -Feature EXTIOI_HAS_CPU_ENCODE is entension of V-EIOINTC. If it is 1, it +Feature EXTIOI_HAS_CPU_ENCODE is extension of V-EIOINTC. If it is 1, it indicates that CPU selection can be normal method rather than bitmap method, so interrupt can be routed to CPU0 - CPU255.
Signature · 1 line
2.34.1
PATCH v2 8/9 docs: admin-guide: tainted-kernels: fixed spelling mistake in documentation
In reply to Soham Methafound/fixed the following typo
- userpace -> userspace
in Documentation/admin-guide/tainted-kernels.rst
--- Documentation/admin-guide/tainted-kernels.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/tainted-kernels.rst +1 -1
@@ -186,6 +186,6 @@ More detailed explanation for tainting 18) ``N`` if an in-kernel test, such as a KUnit test, has been run. - 19) ``J`` if userpace opened /dev/fwctl/* and performed a FWTCL_RPC_DEBUG_WRITE + 19) ``J`` if userspace opened /dev/fwctl/* and performed a FWTCL_RPC_DEBUG_WRITE to use the devices debugging features. Device debugging features could cause the device to malfunction in undefined ways.
Signature · 1 line
2.34.1
PATCH v2 9/9 docs: symbol-namespaces: fixed spelling mistake in documentation
In reply to Soham Methafound/fixed the following typo
- whoes -> whose
in Documentation/core-api/symbol-namespaces.rst
--- Documentation/core-api/symbol-namespaces.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/core-api/symbol-namespaces.rst +1 -1
@@ -89,7 +89,7 @@ For example:: EXPORT_SYMBOL_GPL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-*") -will limit usage of this symbol to modules whoes name matches the given +will limit usage of this symbol to modules whose name matches the given patterns. How to use Symbols exported in Namespaces
Signature · 1 line
2.34.1