Re: [RFC PATCH 6/7] Docs/admin-guide/mm/damon/usage: update for quota goal complement file

[SJ Park <sj@kernel.org>]

On Fri, 18 Sep 2026 15:09:33 +0000 sashiko-bot@kernel.org wrote:

> 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.

Nice catch!  I will fix this in the next revision.

> 
> > +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


Thanks,
SJ