Re: [RFC PATCH v2 16/17] Docs/admin-guide/mm/damon/usage: document probe preps sysfs files

[email protected] Sun, 26 Jul 2026 17:45:47 +0000
Newsgroups dev.linux.lists.damon
Message-ID <[email protected]>
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] Typo in documentation: 'names' used instead of 'named'.
- [Low] Subject-verb agreement error in updated documentation sentence.
--

--- Patch [16]: [RFC PATCH v2 16/17] Docs/admin-guide/mm/damon/usage: document probe preps sysfs files ---
commit a784c34ebf2a666ab86343b9b4f5290f8391e1b3
Author: SJ Park <[email protected]>

Docs/admin-guide/mm/damon/usage: document probe preps sysfs files

Update DAMON usage document for the newly added DAMON probe preps sysfs files.

> diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> index da5f9afd08aef..e4fdec3fa5059 100644
> --- a/Documentation/admin-guide/mm/damon/usage.rst
> +++ b/Documentation/admin-guide/mm/damon/usage.rst

[ ... ]

> @@ -283,9 +286,18 @@ In the beginning, this directory has only one file, ``nr_probes``.  Writing a
>  number (``N``) to the file creates the number of child directories named ``0``
>  to ``N-1``.  Each directory represents each monitoring probe.
>  
> -In each probe directory, one directory, ``filters`` exists.  The directory
> -contains files for installing filters for the probe, that is used to determine
> -the data attribute for the probe.
> +In each probe directory, two directories, ``preps`` and ``filters`` exist.  The
> +directories contain files for installing probing preparation actions and
> +filters for the probe, that is used to determine the data attribute for the
                              ^^^^^^^

[Severity: Low]
This isn't a bug, but since the sentence refers to plural subjects
("preparation actions and filters" or "files"), should "that is used" be 
updated to "that are used"?

> +probe.
> +
> +In the beginning, ``preps`` directory has only one file, ``nr_preps``.
> +Writing a number (``N``) to the file creates the number of child directories
> +names ``0`` to ``N-1``.  Each directory represents each preparation action.
   ^^^^^

[Severity: Low]
This isn't a bug, but there appears to be a typo. Should "names" be "named"
to match the intended meaning ("child directories named 0 to N-1")?

-- 
Sashiko AI review ยท https://sashiko.dev/#/patchset/[email protected]?part=16