Re: [PATCH] Documentation: fix a few typo and wording issues

From: Randy Dunlap

Date: Mon Jul 27 2026 - 23:23:16 EST


Hi,

On 7/27/26 8:07 PM, 岳秉坤 wrote:
> Hi,
>
> This patch fixes a few small documentation issues in Documentation/ files.

These changes look good to me. Thanks.
Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

> I am a newcomer to the Linux community, and I am eager to contribute
> and learn through small, helpful fixes like this one.
>
However, there are probably some process issues here.

E.g., the 2 lines above should not be part of the commit message. You can
include them after the "---" line just after your Signed-off-by: line.

> These changes are limited to spelling and wording corrections and do not
> change behavior.
>
> Signed-off-by: 岳秉坤 <yuebingkun@xxxxxxxxxx>
> ---
> Documentation/ABI/README | 2 +-
> Documentation/ABI/testing/sysfs-edac-memory-repair | 2 +-
> .../userspace-api/media/v4l/vidioc-subdev-g-routing.rst | 2 +-
> 3 files changed, 3 insertions(+), 3 deletions(-)
>

and it's up to various maintainers as to whether the patch will have to be
split up into multiple patches to be applied.

> diff --git a/Documentation/ABI/README b/Documentation/ABI/README
> index 315fffe1f831f..27c962e6a872c 100644
> --- a/Documentation/ABI/README
> +++ b/Documentation/ABI/README
> @@ -62,7 +62,7 @@ Users: All users of this interface who wish to be notified when
>
>
> Note:
> - The fields should be use a simple notation, compatible with ReST markup.
> + The fields should use a simple notation, compatible with ReST markup.
> Also, the file **should not** have a top-level index, like::
>
> ===
> diff --git a/Documentation/ABI/testing/sysfs-edac-memory-repair b/Documentation/ABI/testing/sysfs-edac-memory-repair
> index 0434a3b23ff3e..ab199132ffd8a 100644
> --- a/Documentation/ABI/testing/sysfs-edac-memory-repair
> +++ b/Documentation/ABI/testing/sysfs-edac-memory-repair
> @@ -160,7 +160,7 @@ Description:
> in trace events, such as CXL DRAM and CXL general media
> error records of CXL memory devices.
>
> - When readng back these attributes, it returns the current
> + When reading back these attributes, it returns the current
> value of memory requested to be repaired.
>
> bank_group - The bank group of the memory to repair.
> diff --git a/Documentation/userspace-api/media/v4l/vidioc-subdev-g-routing.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-routing.rst
> index 6f66ca38589e8..164cf0ad35931 100644
> --- a/Documentation/userspace-api/media/v4l/vidioc-subdev-g-routing.rst
> +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-routing.rst
> @@ -67,7 +67,7 @@ subdevice routing table. This may be smaller or larger than the value of
> drivers may adjust the requested routing table.
>
> The kernel can return a ``num_routes`` value larger than ``len_routes`` from
> -both ioctls. This indicates thare are more routes in the routing table than fits
> +both ioctls. This indicates there are more routes in the routing table than fits
> the ``routes`` array. In this case, the ``routes`` array is filled by the kernel
> with the first ``len_routes`` entries of the subdevice routing table. This is
> not considered to be an error, and the ioctl call succeeds. If the applications

--
~Randy