mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Manuel Ebner <manuelebnerli@mailbox.org>
To: "Adrian Huang (Lenovo)" <adrianhuang0701@gmail.com>,
	SJ Park <sj@kernel.org>,
	 Andrew Morton <akpm@linux-foundation.org>
Cc: damon@lists.linux.dev, linux-mm@kvack.org,
	linux-doc@vger.kernel.org,  linux-kernel@vger.kernel.org,
	Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	 ahuang12@lenovo.com
Subject: Re: [PATCH 1/3] Docs/admin-guide/mm/damon: Fix various typos
Date: Wed, 07 Oct 2026 12:30:33 +0200	[thread overview]
Message-ID: <311d97da9ba4b870ef03aa412586b751bc7da3f5.camel@mailbox.org> (raw)
In-Reply-To: <20261006061549.627-2-adrianhuang0701@gmail.com>

Hi Adrian,

I have read your patch and the affected files. I have found
a lot of issues, non in your patch.

This got kinda big, so if you don't want add it to your series
let me know, then I'll make a patch on top of yours.

Thanks
 Manuel 

On Tue, 2026-10-06 at 14:15 +0800, Adrian Huang (Lenovo) wrote:
> Fix several spelling mistakes found while reading the DAMON
> documentation:
>   * trusworthy -> trustworthy
>   * DAMON_RCLAIM -> DAMON_RECLAIM

There's one more in in a comment in mm/damon/reclaim.c .

>   * charget -> charge
>   * hetmap -> heatmap
>   * colun -> column
>   * evelenth -> eleventh
>   * idlee -> idle
> 
> Signed-off-by: Adrian Huang (Lenovo) <adrianhuang0701@gmail.com>
> ---
>  Documentation/admin-guide/mm/damon/lru_sort.rst | 2 +-

 DAMON-based LRU-lists Sorting (DAMON_LRU_SORT) is a static kernel module that
-aimed to be used for proactive and lightweight data access pattern based
+aims to be ...

-situations including reclamation target pages selection under sudden memory

+situations including reclamation of target pages selection under sudden memory
 pressure.

-DAMON_LRU_SORT finds hot pages (pages of memory regions that showing access
+DAMON_LRU_SORT finds hot pages (pages of memory regions that show access
 rates that higher than a user-specified threshold) and cold pages (pages of
 memory regions that showing no access for a time that longer than a

-You can enable DAMON_LRU_SORT by setting the value of this parameter as ``Y``.
-Setting it as ``N`` disables DAMON_LRU_SORT.  Note that DAMON_LRU_SORT could do
+You can enable DAMON_LRU_SORT by setting the value of this parameter to ``Y``.
+Setting it to ``N`` disables DAMON_LRU_SORT.  Note that DAMON_LRU_SORT could do

-condition.  Refer to below descriptions for the watermarks parameter for this.
+condition.  Refer to below descriptions of the watermarks parameter for this.

set as -> set to, a couple more times

there is '(de)prioritization', '[de]prioritizations' and '[in]active' -> unify

-interval 5 milliseconds in minimum, and 10 seconds in maximum.
+interval to 5 milliseconds in minimum, and to 10 seconds in maximum.

-monitoring.  This can be used to set upper-bound of the monitoring overhead.
+monitoring.  This can be used to set the upper-bound of the monitoring overhead.

nr_lru_sort_tried_hot_regions
-----------------------------

-Number of hot memory regions that tried to be LRU-sorted.
+Number of hot memory regions that try to be LRU-sorted.

bytes_lru_sort_tried_hot_regions
--------------------------------

-Total bytes of hot memory regions that tried to be LRU-sorted.
+Total bytes of hot memory regions that try to be LRU-sorted.

nr_lru_sorted_hot_regions
-------------------------

-Number of hot memory regions that successfully be LRU-sorted.
+Number of hot memory regions that are successfull LRU-sorted.

-Total bytes of hot memory regions that successfully be LRU-sorted.
+Total bytes of hot memory regions that are successfully LRU-sorted.


>  Documentation/admin-guide/mm/damon/reclaim.rst  | 4 ++--

aimed -> aims x2

-DAMON_RECLAIM finds memory regions that didn’t accessed for specific
+DAMON_RECLAIM finds memory regions that weren't accessed for a specific

-out memory regions that didn't accessed longer time first.  System
+out memory regions that weren't accessed longer time first.  System

-automatically activated and deactivated with three memory pressure watermarks.
+automatically be activated and deactivated with three memory pressure watermarks.


Thanks again
 Manuel 

>  Documentation/admin-guide/mm/damon/start.rst    | 6 +++---
>  Documentation/admin-guide/mm/damon/stat.rst     | 2 +-
>  4 files changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/admin-guide/mm/damon/lru_sort.rst b/Documentation/admin-guide/mm/damon/lru_sort.rst
> index b93ca9b0853d..c3b688385681 100644
> --- a/Documentation/admin-guide/mm/damon/lru_sort.rst
> +++ b/Documentation/admin-guide/mm/damon/lru_sort.rst
> @@ -7,7 +7,7 @@ DAMON-based LRU-lists Sorting
>  DAMON-based LRU-lists Sorting (DAMON_LRU_SORT) is a static kernel module that
>  aimed to be used for proactive and lightweight data access pattern based
>  (de)prioritization of pages on their LRU-lists for making LRU-lists a more
> -trusworthy data access pattern source.
> +trustworthy data access pattern source.
>  
>  Where Proactive LRU-lists Sorting is Required?
>  ==============================================
> diff --git a/Documentation/admin-guide/mm/damon/reclaim.rst b/Documentation/admin-guide/mm/damon/reclaim.rst
> index ec7e3e32b4ac..e4e2ffa52e26 100644
> --- a/Documentation/admin-guide/mm/damon/reclaim.rst
> +++ b/Documentation/admin-guide/mm/damon/reclaim.rst
> @@ -55,7 +55,7 @@ enabled
>  
>  Enable or disable DAMON_RECLAIM.
>  
> -You can enable DAMON_RCLAIM by setting the value of this parameter as ``Y``.
> +You can enable DAMON_RECLAIM by setting the value of this parameter as ``Y``.
>  Setting it as ``N`` disables DAMON_RECLAIM.  Note that DAMON_RECLAIM could do
>  no real monitoring and reclamation due to the watermarks-based activation
>  condition.  Refer to below descriptions for the watermarks parameter for this.
> @@ -125,7 +125,7 @@ quota_reset_interval_ms
>  
>  The time/size quota charge reset interval in milliseconds.
>  
> -The charget reset interval for the quota of time (quota_ms) and size
> +The charge reset interval for the quota of time (quota_ms) and size
>  (quota_sz).  That is, DAMON_RECLAIM does not try reclamation for more than
>  quota_ms milliseconds or quota_sz bytes within quota_reset_interval_ms
>  milliseconds.
> diff --git a/Documentation/admin-guide/mm/damon/start.rst b/Documentation/admin-guide/mm/damon/start.rst
> index ec8c34b2d32f..d98b0eb8e771 100644
> --- a/Documentation/admin-guide/mm/damon/start.rst
> +++ b/Documentation/admin-guide/mm/damon/start.rst
> @@ -69,16 +69,16 @@ monitored access pattern of the process from DAMON and shows the pattern in a
>  human readable format.
>  
>  The first line of the output shows the relative access temperature (hotness) of
> -the regions in a single row hetmap format.  Each column on the heatmap
> +the regions in a single row heatmap format.  Each column on the heatmap
>  represents regions of same size on the monitored virtual address space.  The
> -position of the colun on the row and the number on the column represents the
> +position of the column on the row and the number on the column represents the
>  relative location and access temperature of the region.  ``[...]`` means
>  unmapped huge regions on the virtual address spaces.  The second line shows
>  additional information for better understanding the heatmap.
>  
>  Each line of the output from the third line shows which virtual address range
>  (``addr XX size XX``) of the process is how frequently (``access XX %``)
> -accessed for how long time (``age XX``).  For example, the evelenth region of
> +accessed for how long time (``age XX``).  For example, the eleventh region of
>  ~9.5 MiB size is being most frequently accessed for last 3.7 seconds.  Finally,
>  the fourth command stops DAMON.
>  
> diff --git a/Documentation/admin-guide/mm/damon/stat.rst b/Documentation/admin-guide/mm/damon/stat.rst
> index 46c5dd96aa2e..4a9db755a526 100644
> --- a/Documentation/admin-guide/mm/damon/stat.rst
> +++ b/Documentation/admin-guide/mm/damon/stat.rst
> @@ -81,7 +81,7 @@ Per-byte idle time (milliseconds) percentiles of the system.
>  DAMON_STAT calculates how long each byte of the memory was not accessed until
>  now (idle time), based on the current DAMON results snapshot.  For regions
>  having access frequency (nr_accesses) larger than zero, how long the current
> -access frequency level was kept multiplied by ``-1`` becomes the idlee time of
> +access frequency level was kept multiplied by ``-1`` becomes the idle time of
>  every byte of the region.  If a region has zero access frequency (nr_accesses),
>  how long the region was keeping the zero access frequency (age) becomes the
>  idle time of every byte of the region.  Then, DAMON_STAT exposes the

  parent reply	other threads:[~2026-10-07 10:30 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-06  6:15 [PATCH 0/3] Docs/admin-guide/mm/damon: Minor fixes Adrian Huang (Lenovo)
2026-10-06  6:15 ` [PATCH 1/3] Docs/admin-guide/mm/damon: Fix various typos Adrian Huang (Lenovo)
2026-10-06  6:55   ` SJ Park
2026-10-07 10:30   ` Manuel Ebner [this message]
2026-10-07 11:53     ` Huang Adrian
2026-10-06  6:15 ` [PATCH 2/3] Docs/admin-guide/mm/damon/lru_sort: Fix copy-paste mistakes Adrian Huang (Lenovo)
2026-10-06  6:56   ` SJ Park
2026-10-06  6:15 ` [PATCH 3/3] Docs/admin-guide/mm/damon/usage: Fix incorrect option syntax in perf example Adrian Huang (Lenovo)
2026-10-06  6:58   ` SJ Park
2026-10-06  7:03 ` [PATCH 0/3] Docs/admin-guide/mm/damon: Minor fixes SJ Park

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=311d97da9ba4b870ef03aa412586b751bc7da3f5.camel@mailbox.org \
    --to=manuelebnerli@mailbox.org \
    --cc=adrianhuang0701@gmail.com \
    --cc=ahuang12@lenovo.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=damon@lists.linux.dev \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=rdunlap@infradead.org \
    --cc=sj@kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®