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: [PATCH 2/2] Docs/ABI/damon: mark schemes/<S>/filters/ deprecated
Date: Wed, 29 Apr 2026 17:28:53 -0700	[thread overview]
Message-ID: <20260430002854.113319-1-sj@kernel.org> (raw)
In-Reply-To: <20260429193856.4E65FC19425@smtp.kernel.org>

On Wed, 29 Apr 2026 19:38:54 +0000 sashiko-bot@kernel.org wrote:

> Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
> - [Low] Missing `What:` entries for files under the deprecated `filters/` and newly added `ops_filters/` directories.
> --
> 
> commit d4b50ba450c215da3baec9d7d831c83147cf209c
> Author: SeongJae Park <sj@kernel.org>
> 
> Docs/ABI/damon: mark schemes/<S>/filters/ deprecated
> 
> This commit deprecates the filters/ directory in the DAMON sysfs interface
> and updates the ABI documentation to use the new core_filters/ path. It also
> adds documentation for the ops_filters/ and filters/ directories, noting
> they work the same as core_filters/.
> 
> > diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-damon b/Documentation/ABI/testing/sysfs-kernel-mm-damon
> > index 2424237ebb10..b61a34b9b185 100644
> > --- a/Documentation/ABI/testing/sysfs-kernel-mm-damon
> > +++ b/Documentation/ABI/testing/sysfs-kernel-mm-damon
> > @@ -377,15 +377,20 @@ Contact:	SeongJae Park <sj@kernel.org>
> >  Description:	Writing to and reading from this file sets and gets the low
> >  		watermark of the scheme in permil.
> >  
> > -What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/filters/nr_filters
> > -Date:		Dec 2022
> > +What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/core_filters
> > +Date:		Feb 2025
> > +Contact:	SeongJae Park <sj@kernel.org>
> > +Description:	Directory for DAMON core layer-handled DAMOS filters.
> > +
> > +What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/core_filters/nr_filters
> > +Date:		Feb 2025
> >  Contact:	SeongJae Park <sj@kernel.org>
> >  Description:	Writing a number 'N' to this file creates the number of
> >  		directories for setting filters of the scheme named '0' to
> > -		'N-1' under the filters/ directory.
> > +		'N-1' under the core_filters/ directory.
> 
> [ ... ]
> 
> >  What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/ops_filters
> >  Date:		Feb 2025
> >  Contact:	SeongJae Park <sj@kernel.org>
> >  Description:	Directory for DAMON operations set layer-handled DAMOS filters.
> >  		Files under this directory works same to those of
> > -		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/filters
> > +		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/core_filters
> >  		directory.
> >  
> > +What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/filters
> > +Date:		Dec 2022
> > +Contact:	SeongJae Park <sj@kernel.org>
> > +Description:	Directory for DAMOS filters.  Files under this directory works
> > +		same to those of
> > +		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/{core,ops}_filters
> > +		directory.  This is deprecated.  Use the core_filters and
> > +		ops_filters instead.
> 
> Will automated ABI parsing tools like scripts/get_abi.pl be able to find the
> documentation for the individual files under the ops_filters/ and deprecated
> filters/ directories?

Seems now the script is renamed to tools/docs/get_abi.py.  And I'm not very
faimilar with the script, but I confirmed at least 'get_abi.py validate' is not
complaining anything about DAMON.

And this part was anyway like this before this patch.

> 
> Since the What: lines earlier in the patch were renamed from filters/ to
> core_filters/, the old sysfs attributes and the new ops_filters/ attributes
> are no longer explicitly listed. These tools rely strictly on explicit What:
> entries and ignore textual cross-references.
> 
> Should multiple What: lines be stacked above the shared descriptions so that
> the core_filters/, ops_filters/, and filters/ attributes are all correctly
> parsed?

So I will revisit if some people start complaining.


Thanks,
SJ

[...]

      reply	other threads:[~2026-04-30  0:28 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-29 15:03 [PATCH 0/2] mm/damon/sysfs: document filters/ directory as deprecated SeongJae Park
2026-04-29 15:03 ` [PATCH 1/2] Docs/admin-guide/mm/damon/usage: mark scheme filters sysfs dir " SeongJae Park
2026-04-29 15:03 ` [PATCH 2/2] Docs/ABI/damon: mark schemes/<S>/filters/ deprecated SeongJae Park
2026-04-29 19:38   ` sashiko-bot
2026-04-30  0:28     ` SeongJae Park [this message]

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=20260430002854.113319-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