From: SeongJae Park <sj@kernel.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: SeongJae Park <sj@kernel.org>,
"Liam R. Howlett" <Liam.Howlett@oracle.com>,
David Hildenbrand <david@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Lorenzo Stoakes <lorenzo.stoakes@oracle.com>,
Michal Hocko <mhocko@suse.com>, Mike Rapoport <rppt@kernel.org>,
Suren Baghdasaryan <surenb@google.com>,
Vlastimil Babka <vbabka@suse.cz>,
damon@lists.linux.dev, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-mm@kvack.org
Subject: [PATCH 3/8] Docs/mm/damon/design: document DAMON sample modules
Date: Sun, 18 Jan 2026 10:02:54 -0800 [thread overview]
Message-ID: <20260118180305.70023-4-sj@kernel.org> (raw)
In-Reply-To: <20260118180305.70023-1-sj@kernel.org>
People sometimes get confused about the purposes of DAMON
special-purpose modules and sample modules. Clarify those on the design
document by adding a section describing their existence and purposes.
Signed-off-by: SeongJae Park <sj@kernel.org>
---
Documentation/mm/damon/design.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index f3db943d7efc..da0bc40c2261 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -836,3 +836,16 @@ modules for proactive reclamation and LRU lists manipulation are provided. For
more detail, please read the usage documents for those
(:doc:`/admin-guide/mm/damon/reclaim` and
:doc:`/admin-guide/mm/damon/lru_sort`).
+
+
+Sample DAMON Modules
+--------------------
+
+DAMON modules that provides example DAMON kernel API usages.
+
+kernel programmers can build their own special or general purpose DAMON modules
+using DAMON kernel API. To help them easily understand how DAMON kernel API
+can be used, a few sample modules are provided under ``samples/damon/`` of the
+linux source tree. Please note that these modules are not developed for being
+used on real products, but only for showing how DAMON kernel API can be used in
+simple ways.
--
2.47.3
next prev parent reply other threads:[~2026-01-18 18:03 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-18 18:02 [PATCH 0/8] Docs/mm/damon: update intro, modules, maintainer profile, and misc SeongJae Park
2026-01-18 18:02 ` [PATCH 1/8] Docs/mm/damon/index: simplify the intro SeongJae Park
2026-01-18 18:02 ` [PATCH 2/8] Docs/mm/damon/design: link repology instead of Fedora package SeongJae Park
2026-01-18 18:02 ` SeongJae Park [this message]
2026-01-18 18:02 ` [PATCH 4/8] Docs/mm/damon/design: add reference to DAMON_STAT usage SeongJae Park
2026-01-18 18:02 ` [PATCH 5/8] Docs/admin-guide/mm/damon/usage: introduce DAMON modules at the beginning SeongJae Park
2026-01-18 18:02 ` [PATCH 6/8] Docs/admin-guide/mm/damon/usage: update stats update process for refresh_ms SeongJae Park
2026-01-18 18:02 ` [PATCH 7/8] Docs/mm/damon/maintainer-profile: fix wrong MAITNAINERS section name SeongJae Park
2026-01-18 18:02 ` [PATCH 8/8] Docs/mm/damon/maintainer-profile: remove damon-tests/perf suggestion 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=20260118180305.70023-4-sj@kernel.org \
--to=sj@kernel.org \
--cc=Liam.Howlett@oracle.com \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=damon@lists.linux.dev \
--cc=david@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=lorenzo.stoakes@oracle.com \
--cc=mhocko@suse.com \
--cc=rppt@kernel.org \
--cc=surenb@google.com \
--cc=vbabka@suse.cz \
/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