From: sashiko-bot@kernel.org
To: "SJ Park" <sj@kernel.org>
Cc: damon@lists.linux.dev
Subject: Re: [RFC PATCH 6/7] Docs/admin-guide/mm/damon/usage: update for quota goal complement file
Date: Fri, 18 Sep 2026 15:09:33 +0000 [thread overview]
Message-ID: <20260918150934.1CC5B1F0089C@smtp.kernel.org> (raw)
In-Reply-To: <20260918142827.85303-7-sj@kernel.org>
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] damon: inconsistent file count in usage documentation
--
commit 3ff19ca809eb7c0b839b503a68fe82c349a81160
Author: SJ Park <sj@kernel.org>
Docs/admin-guide/mm/damon/usage: update for quota goal complement file
Update DAMON usage document for the newly added quota goal metric
complement sysfs file.
> diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> index ba47255448564..b3f2e591fb7e4 100644
> --- a/Documentation/admin-guide/mm/damon/usage.rst
> +++ b/Documentation/admin-guide/mm/damon/usage.rst
[ ... ]
> @@ -493,11 +494,11 @@ to ``N-1``. Each directory represents each goal and current achievement.
> Among the multiple feedback, the best one is used.
>
> Each goal directory contains five files, namely ``target_metric``,
> -``target_value``, ``current_value``, ``nid``, and ``path``. Users can set and
> -get the five parameters for the quota auto-tuning goals that specified on the
> -:ref:`design doc <damon_design_damos_quotas_auto_tuning>` by writing to and
> -reading from each of the files. Because the kernel does not update
> -``current_value``, reading it only makes sense when ``target_metric`` is
> +``complement``, ``target_value``, ``current_value``, ``nid``, and ``path``.
[Severity: Low]
Does this introductory sentence need to be updated to say six files instead
of five files?
The patch updates the next sentence to say six parameters, but the word five
in the preceding context line was missed, so it now contradicts the list of
six files that immediately follows it.
> +Users can set and get the six parameters for the quota auto-tuning goals that
> +specified on the :ref:`design doc <damon_design_damos_quotas_auto_tuning>` by
> +writing to and reading from each of the files. Because the kernel does not
> +update ``current_value``, reading it only makes sense when ``target_metric`` is
> ``user_input``. Note that users should further write
> ``commit_schemes_quota_goals`` to the ``state`` file of the :ref:`kdamond
> directory <sysfs_kdamond>` to pass the feedback to DAMON.
--
Sashiko AI review · https://sashiko.dev/#/patchset/20260918142827.85303-1-sj@kernel.org?part=6
next prev parent reply other threads:[~2026-09-18 15:09 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-18 14:28 [RFC PATCH 0/7] mm/damon: introduce damos quota goal target metric complement flag SJ Park
2026-09-18 14:28 ` [RFC PATCH 1/7] mm/damon/core: introduce damos_quota_goal->complement SJ Park
2026-09-18 14:48 ` sashiko-bot
2026-09-18 15:08 ` SJ Park
2026-09-18 14:28 ` [RFC PATCH 2/7] mm/damon: add complement argument to damos_new_quota_goal() SJ Park
2026-09-18 14:56 ` sashiko-bot
2026-09-18 14:28 ` [RFC PATCH 3/7] mm/damon/sysfs-schemes: support quota goal complement flag SJ Park
2026-09-18 15:05 ` sashiko-bot
2026-09-18 15:09 ` SJ Park
2026-09-18 14:28 ` [RFC PATCH 4/7] mm/damon/tests/core-kunit: test quota_goal->complement commit SJ Park
2026-09-18 15:07 ` sashiko-bot
2026-09-18 14:28 ` [RFC PATCH 5/7] Docs/mm/damon/design: document damos quota goal complement flag SJ Park
2026-09-18 15:07 ` sashiko-bot
2026-09-18 14:28 ` [RFC PATCH 6/7] Docs/admin-guide/mm/damon/usage: update for quota goal complement file SJ Park
2026-09-18 15:09 ` sashiko-bot [this message]
2026-09-18 15:11 ` SJ Park
2026-09-18 14:28 ` [RFC PATCH 7/7] Docs/ABI/damon: update for quota goal metric complement sysfs file SJ Park
2026-09-18 15:21 ` sashiko-bot
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=20260918150934.1CC5B1F0089C@smtp.kernel.org \
--to=sashiko-bot@kernel.org \
--cc=damon@lists.linux.dev \
--cc=sashiko-reviews@lists.linux.dev \
--cc=sj@kernel.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