Skip to content

mm/damon/sysfs: document filters/ directory as deprecated

SeongJae Park damon linux-doc linux-mm lkml 1 version Applied

Status from this message: [merged mm-stable] docs-abi-damon-mark-schemes-s-filters-deprecated.patch removed from -mm tree

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest2 patches 1 replyApplied 2/2

Patches in v1 All 2 applied

#Subject and filesSizeRepliesApplied
1/2Docs/admin-guide/mm/damon/usage: mark scheme filters sysfs dir as deprecatedDocumentation/admin-guide/mm/damon/usage.rst+4 -40 repliesApplied
2/2Docs/ABI/damon: mark schemes/<S>/filters/ deprecatedDocumentation/ABI/testing/sysfs-kernel-mm-damon+34 -281 replyApplied

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/2] mm/damon/sysfs: document filters/ directory as deprecated

Commit ab71d2d30121 ("mm/damon/sysfs-schemes: let damon_sysfs_scheme_set_filters() be used for different named directories") introduced alternatives of 'filters' directory, namely core_filters/ and 'ops_filters/ directories. Now the alternatives are well stabilized and ready for all users. All filters/ directory use cases are expected to be able to be migrated to the alternatives. An LTS kernel having the alternatives, namely 6.18.y, is also released. Existence of filters/ directory is only confusing.

It would be better not immediately removing the directory, though. There could be users that need time before migrating to the alternatives. There might be unexpected use cases that the alternatives cannot support. Doing the deprecation step by step across multiple years like DAMON debugfs deprecation would be safer. Start the deprecation changes by announcing the deprecation on the documents.

Every year, one more action for completely removing the directory will be followed, like DAMON debugfs deprecation did. Following yearly actions are currently expected. In 2027, deprecation warning kernel messages will be printed once, for use of filters/ directory. In 2028, filters/ directory will be renamed to filters_DEPRECATED/. In 2029, filters_DEPRECATED/ directory will be removed.

Changes from RFC
- rfc: https://lore.kernel.org/[email protected]
- Wordsmith deprecation notice.
- Rebase to latest mm-new.

SeongJae Park (2):
Docs/admin-guide/mm/damon/usage: mark scheme filters sysfs dir as
deprecated
Docs/ABI/damon: mark schemes/<S>/filters/ deprecated

 .../ABI/testing/sysfs-kernel-mm-damon         | 62 ++++++++++---------
 Documentation/admin-guide/mm/damon/usage.rst  |  8 +--
 2 files changed, 38 insertions(+), 32 deletions(-)

base-commit: 97bd4e9ac10095f9b55f4a38d5d0757bc2a287fa

Signature · 1 line
2.47.3