2023-01-28 09:12:28

by Hui Su

Subject: [PATCH] Doc/damon: fix the data path error

%s/modules/module/

Signed-off-by: Hui Su <[email protected]>
---
Documentation/admin-guide/mm/damon/lru_sort.rst | 4 ++--
Documentation/admin-guide/mm/damon/reclaim.rst | 4 ++--
.../translations/zh_CN/admin-guide/mm/damon/reclaim.rst | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/admin-guide/mm/damon/lru_sort.rst b/Documentation/admin-guide/mm/damon/lru_sort.rst
index c09cace80651..7b0775d281b4 100644
--- a/Documentation/admin-guide/mm/damon/lru_sort.rst
+++ b/Documentation/admin-guide/mm/damon/lru_sort.rst
@@ -54,7 +54,7 @@ that is built with ``CONFIG_DAMON_LRU_SORT=y``.
To let sysadmins enable or disable it and tune for the given system,
DAMON_LRU_SORT utilizes module parameters. That is, you can put
``damon_lru_sort.<parameter>=<value>`` on the kernel boot command line or write
-proper values to ``/sys/modules/damon_lru_sort/parameters/<parameter>`` files.
+proper values to ``/sys/module/damon_lru_sort/parameters/<parameter>`` files.

Below are the description of each parameter.

@@ -283,7 +283,7 @@ doesn't make progress and therefore the free memory rate becomes lower than
20%, it asks DAMON_LRU_SORT to do nothing again, so that we can fall back to
the LRU-list based page granularity reclamation. ::

- # cd /sys/modules/damon_lru_sort/parameters
+ # cd /sys/module/damon_lru_sort/parameters
# echo 500 > hot_thres_access_freq
# echo 120000000 > cold_min_age
# echo 10 > quota_ms
diff --git a/Documentation/admin-guide/mm/damon/reclaim.rst b/Documentation/admin-guide/mm/damon/reclaim.rst
index 4f1479a11e63..d2ccd9c21b9a 100644
--- a/Documentation/admin-guide/mm/damon/reclaim.rst
+++ b/Documentation/admin-guide/mm/damon/reclaim.rst
@@ -46,7 +46,7 @@ that is built with ``CONFIG_DAMON_RECLAIM=y``.
To let sysadmins enable or disable it and tune for the given system,
DAMON_RECLAIM utilizes module parameters. That is, you can put
``damon_reclaim.<parameter>=<value>`` on the kernel boot command line or write
-proper values to ``/sys/modules/damon_reclaim/parameters/<parameter>`` files.
+proper values to ``/sys/module/damon_reclaim/parameters/<parameter>`` files.

Below are the description of each parameter.

@@ -251,7 +251,7 @@ therefore the free memory rate becomes lower than 20%, it asks DAMON_RECLAIM to
do nothing again, so that we can fall back to the LRU-list based page
granularity reclamation. ::

- # cd /sys/modules/damon_reclaim/parameters
+ # cd /sys/module/damon_reclaim/parameters
# echo 30000000 > min_age
# echo $((1 * 1024 * 1024 * 1024)) > quota_sz
# echo 1000 > quota_reset_interval_ms
diff --git a/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst b/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
index c976f3e33ffd..d15a2f20bb11 100644
--- a/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
+++ b/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
@@ -45,7 +45,7 @@ DAMON_RECLAIM找到在特定时间内没有被访问的内存区域并分页。

为了让系统管理员启用或禁用它，并为给定的系统进行调整，DAMON_RECLAIM利用了模块参数。也就
是说，你可以把 ``damon_reclaim.<parameter>=<value>`` 放在内核启动命令行上，或者把
-适当的值写入 ``/sys/modules/damon_reclaim/parameters/<parameter>`` 文件。
+适当的值写入 ``/sys/module/damon_reclaim/parameters/<parameter>`` 文件。

注意，除 ``启用`` 外的参数值只在DAMON_RECLAIM启动时应用。因此，如果你想在运行时应用新
的参数值，而DAMON_RECLAIM已经被启用，你应该通过 ``启用`` 的参数文件禁用和重新启用它。
@@ -218,7 +218,7 @@ nr_quota_exceeds
就开始真正的工作。如果DAMON_RECLAIM没有取得进展，因此空闲内存率低于20%，它会要求
DAMON_RECLAIM再次什么都不做，这样我们就可以退回到基于LRU列表的页面粒度回收了::

- # cd /sys/modules/damon_reclaim/parameters
+ # cd /sys/module/damon_reclaim/parameters
# echo 30000000 > min_age
# echo $((1 * 1024 * 1024 * 1024)) > quota_sz
# echo 1000 > quota_reset_interval_ms
--
2.34.1

2023-01-28 18:55:12

by SeongJae Park

Subject: Re: [PATCH] Doc/damon: fix the data path error

Hi Hui,

On Sat, 28 Jan 2023 17:11:48 +0800 Hui Su <[email protected]> wrote:

> %s/modules/module/
>
> Signed-off-by: Hui Su <[email protected]>

Reviewed-by: SeongJae Park <[email protected]>

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

I realized DAMON documentation is also translated for Chinese today! Thank you
for letting me know this, and also thanks to the translators!


Thanks,
SJ

> 3 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/admin-guide/mm/damon/lru_sort.rst b/Documentation/admin-guide/mm/damon/lru_sort.rst
> index c09cace80651..7b0775d281b4 100644
> --- a/Documentation/admin-guide/mm/damon/lru_sort.rst
> +++ b/Documentation/admin-guide/mm/damon/lru_sort.rst
> @@ -54,7 +54,7 @@ that is built with ``CONFIG_DAMON_LRU_SORT=y``.
> To let sysadmins enable or disable it and tune for the given system,
> DAMON_LRU_SORT utilizes module parameters. That is, you can put
> ``damon_lru_sort.<parameter>=<value>`` on the kernel boot command line or write
> -proper values to ``/sys/modules/damon_lru_sort/parameters/<parameter>`` files.
> +proper values to ``/sys/module/damon_lru_sort/parameters/<parameter>`` files.
>
> Below are the description of each parameter.
>
> @@ -283,7 +283,7 @@ doesn't make progress and therefore the free memory rate becomes lower than
> 20%, it asks DAMON_LRU_SORT to do nothing again, so that we can fall back to
> the LRU-list based page granularity reclamation. ::
>
> - # cd /sys/modules/damon_lru_sort/parameters
> + # cd /sys/module/damon_lru_sort/parameters
> # echo 500 > hot_thres_access_freq
> # echo 120000000 > cold_min_age
> # echo 10 > quota_ms
> diff --git a/Documentation/admin-guide/mm/damon/reclaim.rst b/Documentation/admin-guide/mm/damon/reclaim.rst
> index 4f1479a11e63..d2ccd9c21b9a 100644
> --- a/Documentation/admin-guide/mm/damon/reclaim.rst
> +++ b/Documentation/admin-guide/mm/damon/reclaim.rst
> @@ -46,7 +46,7 @@ that is built with ``CONFIG_DAMON_RECLAIM=y``.
> To let sysadmins enable or disable it and tune for the given system,
> DAMON_RECLAIM utilizes module parameters. That is, you can put
> ``damon_reclaim.<parameter>=<value>`` on the kernel boot command line or write
> -proper values to ``/sys/modules/damon_reclaim/parameters/<parameter>`` files.
> +proper values to ``/sys/module/damon_reclaim/parameters/<parameter>`` files.
>
> Below are the description of each parameter.
>
> @@ -251,7 +251,7 @@ therefore the free memory rate becomes lower than 20%, it asks DAMON_RECLAIM to
> do nothing again, so that we can fall back to the LRU-list based page
> granularity reclamation. ::
>
> - # cd /sys/modules/damon_reclaim/parameters
> + # cd /sys/module/damon_reclaim/parameters
> # echo 30000000 > min_age
> # echo $((1 * 1024 * 1024 * 1024)) > quota_sz
> # echo 1000 > quota_reset_interval_ms
> diff --git a/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst b/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
> index c976f3e33ffd..d15a2f20bb11 100644
> --- a/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
> +++ b/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
> @@ -45,7 +45,7 @@ DAMON_RECLAIM找到在特定时间内没有被访问的内存区域并分页。
>
> 为了让系统管理员启用或禁用它，并为给定的系统进行调整，DAMON_RECLAIM利用了模块参数。也就
> 是说，你可以把 ``damon_reclaim.<parameter>=<value>`` 放在内核启动命令行上，或者把
> -适当的值写入 ``/sys/modules/damon_reclaim/parameters/<parameter>`` 文件。
> +适当的值写入 ``/sys/module/damon_reclaim/parameters/<parameter>`` 文件。
>
> 注意，除 ``启用`` 外的参数值只在DAMON_RECLAIM启动时应用。因此，如果你想在运行时应用新
> 的参数值，而DAMON_RECLAIM已经被启用，你应该通过 ``启用`` 的参数文件禁用和重新启用它。
> @@ -218,7 +218,7 @@ nr_quota_exceeds
> 就开始真正的工作。如果DAMON_RECLAIM没有取得进展，因此空闲内存率低于20%，它会要求
> DAMON_RECLAIM再次什么都不做，这样我们就可以退回到基于LRU列表的页面粒度回收了::
>
> - # cd /sys/modules/damon_reclaim/parameters
> + # cd /sys/module/damon_reclaim/parameters
> # echo 30000000 > min_age
> # echo $((1 * 1024 * 1024 * 1024)) > quota_sz
> # echo 1000 > quota_reset_interval_ms
> --
> 2.34.1

2023-01-30 09:05:53

by Alex Shi

Subject: Re: [PATCH] Doc/damon: fix the data path error

Reviewed-by: Alex Shi <[email protected]>

On Sat, Jan 28, 2023 at 5:12 PM Hui Su <[email protected]> wrote:
>
> %s/modules/module/
>
> Signed-off-by: Hui Su <[email protected]>
> ---
> Documentation/admin-guide/mm/damon/lru_sort.rst | 4 ++--
> Documentation/admin-guide/mm/damon/reclaim.rst | 4 ++--
> .../translations/zh_CN/admin-guide/mm/damon/reclaim.rst | 4 ++--
> 3 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/admin-guide/mm/damon/lru_sort.rst b/Documentation/admin-guide/mm/damon/lru_sort.rst
> index c09cace80651..7b0775d281b4 100644
> --- a/Documentation/admin-guide/mm/damon/lru_sort.rst
> +++ b/Documentation/admin-guide/mm/damon/lru_sort.rst
> @@ -54,7 +54,7 @@ that is built with ``CONFIG_DAMON_LRU_SORT=y``.
> To let sysadmins enable or disable it and tune for the given system,
> DAMON_LRU_SORT utilizes module parameters. That is, you can put
> ``damon_lru_sort.<parameter>=<value>`` on the kernel boot command line or write
> -proper values to ``/sys/modules/damon_lru_sort/parameters/<parameter>`` files.
> +proper values to ``/sys/module/damon_lru_sort/parameters/<parameter>`` files.
>
> Below are the description of each parameter.
>
> @@ -283,7 +283,7 @@ doesn't make progress and therefore the free memory rate becomes lower than
> 20%, it asks DAMON_LRU_SORT to do nothing again, so that we can fall back to
> the LRU-list based page granularity reclamation. ::
>
> - # cd /sys/modules/damon_lru_sort/parameters
> + # cd /sys/module/damon_lru_sort/parameters
> # echo 500 > hot_thres_access_freq
> # echo 120000000 > cold_min_age
> # echo 10 > quota_ms
> diff --git a/Documentation/admin-guide/mm/damon/reclaim.rst b/Documentation/admin-guide/mm/damon/reclaim.rst
> index 4f1479a11e63..d2ccd9c21b9a 100644
> --- a/Documentation/admin-guide/mm/damon/reclaim.rst
> +++ b/Documentation/admin-guide/mm/damon/reclaim.rst
> @@ -46,7 +46,7 @@ that is built with ``CONFIG_DAMON_RECLAIM=y``.
> To let sysadmins enable or disable it and tune for the given system,
> DAMON_RECLAIM utilizes module parameters. That is, you can put
> ``damon_reclaim.<parameter>=<value>`` on the kernel boot command line or write
> -proper values to ``/sys/modules/damon_reclaim/parameters/<parameter>`` files.
> +proper values to ``/sys/module/damon_reclaim/parameters/<parameter>`` files.
>
> Below are the description of each parameter.
>
> @@ -251,7 +251,7 @@ therefore the free memory rate becomes lower than 20%, it asks DAMON_RECLAIM to
> do nothing again, so that we can fall back to the LRU-list based page
> granularity reclamation. ::
>
> - # cd /sys/modules/damon_reclaim/parameters
> + # cd /sys/module/damon_reclaim/parameters
> # echo 30000000 > min_age
> # echo $((1 * 1024 * 1024 * 1024)) > quota_sz
> # echo 1000 > quota_reset_interval_ms
> diff --git a/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst b/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
> index c976f3e33ffd..d15a2f20bb11 100644
> --- a/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
> +++ b/Documentation/translations/zh_CN/admin-guide/mm/damon/reclaim.rst
> @@ -45,7 +45,7 @@ DAMON_RECLAIM找到在特定时间内没有被访问的内存区域并分页。
>
> 为了让系统管理员启用或禁用它，并为给定的系统进行调整，DAMON_RECLAIM利用了模块参数。也就
> 是说，你可以把 ``damon_reclaim.<parameter>=<value>`` 放在内核启动命令行上，或者把
> -适当的值写入 ``/sys/modules/damon_reclaim/parameters/<parameter>`` 文件。
> +适当的值写入 ``/sys/module/damon_reclaim/parameters/<parameter>`` 文件。
>
> 注意，除 ``启用`` 外的参数值只在DAMON_RECLAIM启动时应用。因此，如果你想在运行时应用新
> 的参数值，而DAMON_RECLAIM已经被启用，你应该通过 ``启用`` 的参数文件禁用和重新启用它。
> @@ -218,7 +218,7 @@ nr_quota_exceeds
> 就开始真正的工作。如果DAMON_RECLAIM没有取得进展，因此空闲内存率低于20%，它会要求
> DAMON_RECLAIM再次什么都不做，这样我们就可以退回到基于LRU列表的页面粒度回收了::
>
> - # cd /sys/modules/damon_reclaim/parameters
> + # cd /sys/module/damon_reclaim/parameters
> # echo 30000000 > min_age
> # echo $((1 * 1024 * 1024 * 1024)) > quota_sz
> # echo 1000 > quota_reset_interval_ms
> --
> 2.34.1
>

2023-01-31 20:59:14

by Jonathan Corbet

Subject: Re: [PATCH] Doc/damon: fix the data path error

Hui Su <[email protected]> writes:

> %s/modules/module/
>
> Signed-off-by: Hui Su <[email protected]>
> ---
> Documentation/admin-guide/mm/damon/lru_sort.rst | 4 ++--
> Documentation/admin-guide/mm/damon/reclaim.rst | 4 ++--
> .../translations/zh_CN/admin-guide/mm/damon/reclaim.rst | 4 ++--
> 3 files changed, 6 insertions(+), 6 deletions(-)

Applied, thanks.

jon