DAMON development mailing list
 help / color / mirror / Atom feed
From: SeongJae Park <sj@kernel.org>
To: sashiko-bot@kernel.org
Cc: SeongJae Park <sj@kernel.org>, damon@lists.linux.dev
Subject: Re: [RFC PATCH v3 28/28] Docs/admin-guide/mm/damon/usage: update for memcg damon filter
Date: Sat, 16 May 2026 14:57:42 -0700	[thread overview]
Message-ID: <20260516215743.3654-1-sj@kernel.org> (raw)
In-Reply-To: <20260516190932.1B49AC19425@smtp.kernel.org>

On Sat, 16 May 2026 19:09:31 +0000 sashiko-bot@kernel.org wrote:

> Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
> - [Medium] Inconsistent sysfs UAPI naming for identical memcg filter concepts ('path' vs 'memcg_path').
> - [Low] Awkward and non-standard grammar in the documentation.
> --
> 
> commit eca4a8cfbb76f7f5c4df18fb3c84beeef902be91
> Author: SeongJae Park <sj@kernel.org>
> 
> Docs/admin-guide/mm/damon/usage: update for memcg damon filter
> 
> Update DAMON usage document for the newly added belonging memory cgroup
> attribute monitoring feature.
> 
> > diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> > index 7b6074a1666f3..b4584c0e4cd72 100644
> > --- a/Documentation/admin-guide/mm/damon/usage.rst
> > +++ b/Documentation/admin-guide/mm/damon/usage.rst
> 
> [ ... ]
> 
> > @@ -283,7 +283,9 @@ the data attribute for the probe.
> >  In the beginning, ``filters`` directory has only one file, ``nr_filters``.
> >  Writing a number (``N``) to the file creates the number of child directories
> >  named ``0`` to ``N-1``.  Each directory represents each filter and works in a
> > -way similar to that for :ref:`DAMOS filter <sysfs_filters>`.
> > +way similar to that for :ref:`DAMOS filter <sysfs_filters>`.  When the filter
> > +``type`` is ``memcg``, ``path`` file works the role of ``memcg_path`` for
>                                       ^^^^^^^^^^^^^^^^^^
> 
> This isn't a bug, but this phrasing is non-standard. Would it be clearer
> to use "acts as" or "serves the same role as"?

Good catch, I will update the next version to use "acts as".

> 
> Also, does exposing this as "path" instead of "memcg_path" create an
> inconsistent sysfs UAPI?
> 
> DAMOS memcg filters use "memcg_path" for the exact same concept. Could the
> underlying kernel implementation rename "path" to "memcg_path" before the
> interface is finalized to keep the naming consistent?

No, I'm here to avoid such thing.

> 
> > +:ref:`DAMOS filter <sysfs_filters>`.
> >  
> >  .. _sysfs_targets:
> >
> 
> -- 
> Sashiko AI review · https://sashiko.dev/#/patchset/20260516183712.81393-1-sj@kernel.org?part=28


Thanks,
SJ

  reply	other threads:[~2026-05-16 21:58 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-16 18:36 [RFC PATCH v3 00/28] mm/damon: introduce data attributes monitoring SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 01/28] mm/damon/core: introduce struct damon_probe SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 02/28] mm/damon/core: embed damon_probe objects in damon_ctx SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 03/28] mm/damon/core: introduce damon_filter SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 04/28] mm/damon/core: commit probes SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 05/28] mm/damon/core: introduce damon_region->probe_hits SeongJae Park
2026-05-16 18:54   ` sashiko-bot
2026-05-16 21:26     ` SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 06/28] mm/damon/core: introduce damon_ops->apply_probes SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 07/28] mm/damon/core: do data attributes monitoring SeongJae Park
2026-05-16 19:00   ` sashiko-bot
2026-05-16 21:33     ` SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 08/28] mm/damon/paddr: support " SeongJae Park
2026-05-16 19:05   ` sashiko-bot
2026-05-16 21:46     ` SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 09/28] mm/damon/sysfs: implement probes dir SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 10/28] mm/damon/sysfs: implement probe dir SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 11/28] mm/damon/sysfs: implement filters directory SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 12/28] mm/damon/sysfs: implement filter dir SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 13/28] mm/damon/sysfs: implement filter dir files SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 14/28] mm/damon/sysfs: setup probes on DAMON core API parameters SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 15/28] mm/damon/sysfs-schemes: implement tried_regions/<r>/probes/ SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 16/28] mm/damon/sysfs-schemes: implement probe dir SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 17/28] mm/damon/sysfs-schemes: implement probe/hits file SeongJae Park
2026-05-16 18:36 ` [RFC PATCH v3 18/28] mm/damon: trace probe_hits SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 19/28] selftests/damon/sysfs.sh: test probes dir SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 20/28] Docs/mm/damon/design: document data attributes monitoring SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 21/28] Docs/admin-guide/mm/damon/usage: " SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 22/28] mm/damon/core: introduce DAMON_FILTER_TYPE_MEMCG SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 23/28] mm/damon/paddr: support DAMON_FILTER_TYPE_MEMCG SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 24/28] mm/damon/sysfs: add filters/<F>/path file SeongJae Park
2026-05-16 19:29   ` sashiko-bot
2026-05-16 21:51     ` SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 25/28] mm/damon/sysfs-schemes: move memcg_path_to_id() to sysfs-common SeongJae Park
2026-05-16 19:16   ` sashiko-bot
2026-05-16 21:54     ` SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 26/28] mm/damon/sysfs: setup damon_filter->memcg_id from path SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 27/28] Docs/mm/damon/design: update for memcg damon filter SeongJae Park
2026-05-16 18:37 ` [RFC PATCH v3 28/28] Docs/admin-guide/mm/damon/usage: " SeongJae Park
2026-05-16 19:09   ` sashiko-bot
2026-05-16 21:57     ` SeongJae Park [this message]
2026-05-16 18:50 ` [RFC PATCH v3 00/28] mm/damon: introduce data attributes monitoring SeongJae Park
2026-05-16 22:03 ` SeongJae 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=20260516215743.3654-1-sj@kernel.org \
    --to=sj@kernel.org \
    --cc=damon@lists.linux.dev \
    --cc=sashiko-bot@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