From: SeongJae Park <sj@kernel.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: SeongJae Park <sj@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
damon@lists.linux.dev, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-mm@kvack.org
Subject: [PATCH 03/16] Docs/admin-guide/mm/damon/usage: link damos stat design doc
Date: Mon, 6 Jan 2025 11:33:48 -0800 [thread overview]
Message-ID: <20250106193401.109161-4-sj@kernel.org> (raw)
In-Reply-To: <20250106193401.109161-1-sj@kernel.org>
DAMON sysfs usage document focuses on usage, rather than the detail of
the stat metric itself. Add a link to the design document on DAMOS stat
usage section.
Signed-off-by: SeongJae Park <sj@kernel.org>
---
Documentation/admin-guide/mm/damon/usage.rst | 3 ++-
Documentation/mm/damon/design.rst | 2 ++
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index c685d87ea078..2e835c9bcfdf 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -451,7 +451,8 @@ schemes/<N>/stats/
DAMON counts the total number and bytes of regions that each scheme is tried to
be applied, the two numbers for the regions that each scheme is successfully
applied, and the total number of the quota limit exceeds. This statistics can
-be used for online analysis or tuning of the schemes.
+be used for online analysis or tuning of the schemes. Refer to :ref:`design
+doc <damon_design_damos_stat>` for more details about the stats.
The statistics can be retrieved by reading the files under ``stats`` directory
(``nr_tried``, ``sz_tried``, ``nr_applied``, ``sz_applied``, and
diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index aa2e4694ee14..158d0a4e1d7f 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -539,6 +539,8 @@ To know how user-space can set the watermarks via :ref:`DAMON sysfs interface
<sysfs_interface>`, refer to :ref:`filters <sysfs_filters>` part of the
documentation.
+.. _damon_design_damos_stat:
+
Statistics
~~~~~~~~~~
--
2.39.5
next prev parent reply other threads:[~2025-01-06 19:34 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-06 19:33 [PATCH 00/16] mm/damon: enable page level properties based monitoring SeongJae Park
2025-01-06 19:33 ` [PATCH 01/16] mm/damon: clarify trying vs applying on damos_stat kernel-doc comment SeongJae Park
2025-01-06 19:33 ` [PATCH 02/16] Docs/mm/damon/design: add 'statistics' section SeongJae Park
2025-01-06 19:33 ` SeongJae Park [this message]
2025-01-06 19:33 ` [PATCH 04/16] mm/damon: ask apply_scheme() to report filter-passed region-internal bytes SeongJae Park
2025-01-06 19:33 ` [PATCH 05/16] mm/damon/paddr: report filter-passed bytes back for normal actions SeongJae Park
2025-01-06 19:33 ` [PATCH 06/16] mm/damon/paddr: report filter-passed bytes back for DAMOS_STAT action SeongJae Park
2025-01-06 19:33 ` [PATCH 07/16] mm/damon/core: implement per-scheme ops-handled filter-passed bytes stat SeongJae Park
2025-01-06 19:33 ` [PATCH 08/16] mm/damon/syfs-schemes: implement per-scheme " SeongJae Park
2025-01-06 19:33 ` [PATCH 09/16] Docs/mm/damon/design: document sz_ops_filter_passed SeongJae Park
2025-01-06 19:33 ` [PATCH 10/16] Docs/admin-guide/mm/damon/usage: " SeongJae Park
2025-01-06 19:33 ` [PATCH 11/16] Docs/ABI/damon: document per-scheme filter-passed bytes stat file SeongJae Park
2025-01-06 19:33 ` [PATCH 12/16] mm/damon/core: pass per-region filter-passed bytes to damos_walk_control->walk_fn() SeongJae Park
2025-01-06 19:33 ` [PATCH 13/16] mm/damon/sysfs-schemes: expose per-region filter-passed bytes SeongJae Park
2025-01-06 19:33 ` [PATCH 14/16] Docs/mm/damon/design: document per-region sz_filter_passed stat SeongJae Park
2025-01-06 19:34 ` [PATCH 15/16] Docs/admin-guide/mm/damon/usage: document sz_filtered_out of scheme tried region directories SeongJae Park
2025-01-06 19:34 ` [PATCH 16/16] Docs/ABI/damon: document per-region DAMOS filter-passed bytes stat file 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=20250106193401.109161-4-sj@kernel.org \
--to=sj@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=damon@lists.linux.dev \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.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