Re: [PATCH v3] Docs/admin-guide/mm/damon/reclaim: improve language

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] Docs/mm/damon: typo 'aimes' introduced in reclaim.rst
--

commit 553db5dbc4617619eacc8a4470aca6b0504960ff
Author: Manuel Ebner <manuelebnerli@mailbox.org>

Docs/admin-guide/mm/damon/reclaim: improve language

This commit improves the grammar, tense consistency, and phrasing in the
DAMON_RECLAIM administration guide documentation.

> diff --git a/Documentation/admin-guide/mm/damon/reclaim.rst b/Documentation/admin-guide/mm/damon/reclaim.rst
> index 028947f5da8ec..aeb2770f1d03e 100644
> --- a/Documentation/admin-guide/mm/damon/reclaim.rst
> +++ b/Documentation/admin-guide/mm/damon/reclaim.rst
> @@ -4,7 +4,7 @@
>  DAMON-based Reclamation
>  =======================
>  
> -DAMON-based Reclamation (DAMON_RECLAIM) is a static kernel module that aimed to
> +DAMON-based reclamation (DAMON_RECLAIM) is a static kernel module that aimes to
>  be used for proactive and lightweight reclamation under light memory pressure.
>  It doesn't aim to replace the LRU-list based page_granularity reclamation, but
>  to be selectively used for different level of memory pressure and requirements.

[Severity: Low]
In the DAMON-based Reclamation introduction in
Documentation/admin-guide/mm/damon/reclaim.rst, "aimes" is a typo. Should
this be "aims" instead?

[ ... ]

> @@ -88,7 +89,7 @@ identifies the region as cold, and reclaims it.
>  autotune_monitoring_intervals
>  -----------------------------
>  
> -If this parameter is set as ``Y``, DAMON_RECLAIM automatically tunes DAMON's
> +If this parameter is set to ``Y``, DAMON_RECLAIM automatically tunes DAMON's
>  sampling and aggregation intervals.  The auto-tuning aims to capture meaningful
>  amount of access events in each DAMON-snapshot, while keeping the sampling
>  interval 5 milliseconds in minimum, and 10 seconds in maximum.  Setting this as
> @@ -113,10 +114,10 @@ quota_sz

[ ... ]

> @@ -137,7 +138,7 @@ quota_mem_pressure_us
>  
>  Desired level of memory pressure-stall time in microseconds.
>  
> -While keeping the caps that set by other quotas, DAMON_RECLAIM automatically
> +While keeping the caps that are set by other quotas, DAMON_RECLAIM automatically
>  increases and decreases the effective level of the quota aiming this level of
>  memory pressure is incurred.  System-wide ``some`` memory PSI in microseconds
>  per quota reset interval (``quota_reset_interval_ms``) is collected and

Also, this isn't a bug, but in the autotune_monitoring_intervals section just
above:

  Setting this as ``N`` disables the auto-tuning.

and in the quota_autotune_feedback section just below quota_mem_pressure_us:

  While keeping the caps that set by other quotas, DAMON_RECLAIM automatically

should those also be updated to "Setting this to" and "that are set by" to
match the changes in this patch?

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261103120043.100887-2-manuelebnerli@mailbox.org?part=1