linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: SeongJae Park <sj@kernel.org>
Cc: kernel-team@meta.com, SeongJae Park <sj@kernel.org>,
	damon@lists.linux.dev, linux-mm@kvack.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [RFC PATCH 04/18] Docs/admin-guide/mm/damon/usage: link damos stat design doc
Date: Wed, 18 Dec 2024 20:03:13 -0800	[thread overview]
Message-ID: <20241219040327.61902-5-sj@kernel.org> (raw)
In-Reply-To: <20241219040327.61902-1-sj@kernel.org>

DAMON sysfs usage document should focus on usage, rather than the detail
of the stat metric itself.  Add a link to the design document on usage
section for DAMOS stat.

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 d9be9f7caa7d..af70f7244700 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -457,7 +457,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 8710fa71ad71..e2666124e382 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



  parent reply	other threads:[~2024-12-19  4:03 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-19  4:03 [RFC PATCH 00/18] mm/damon: enable page level properties based access pattern monitoring SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 01/18] mm/damon: clarify trying vs applying on damos_stat kernel-doc comment SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 02/18] Docs/mm/damon/design: document DAMOS regions walking SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 03/18] Docs/mm/damon/design: add 'statistics' section SeongJae Park
2024-12-19  4:03 ` SeongJae Park [this message]
2024-12-19  4:03 ` [RFC PATCH 05/18] mm/damon: ask apply_scheme() to report filter-passed region-internal bytes SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 06/18] mm/damon/paddr: report filter-passed bytes back for normal actions SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 07/18] mm/damon/paddr: report filter-passed bytes back for DAMOS_STAT action SeongJae Park
2025-01-13 19:49   ` Joshua Hahn
2025-01-13 20:02     ` SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 08/18] mm/damon/core: implement per-scheme filter-passed bytes stat SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 09/18] mm/damon/syfs-schemes: " SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 10/18] Docs/mm/damon/design: document sz_ops_filter_passed SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 11/18] Docs/admin-guide/mm/damon/usage: " SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 12/18] Docs/ABI/damon: document per-scheme filter-passed bytes stat file SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 13/18] mm/damon/core: invoke damos_walk_control->walk_fn() after applying action SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 14/18] mm/damon/core: pass per-region filter-passed bytes to damos_walk_control->walk_fn() SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 15/18] mm/damon/sysfs-schemes: expose per-region filter-passed bytes SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 16/18] Docs/mm/damon/design: document per-region sz_filter_passed stat SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 17/18] Docs/admin-guide/mm/damon/usage: document sz_filtered_out of scheme tried region directories SeongJae Park
2024-12-19  4:03 ` [RFC PATCH 18/18] Docs/ABI/damon: document per-region DAMOS filter-passed bytes stat file SeongJae Park
2024-12-23 20:24 ` [RFC PATCH 00/18] mm/damon: enable page level properties based access pattern monitoring 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=20241219040327.61902-5-sj@kernel.org \
    --to=sj@kernel.org \
    --cc=damon@lists.linux.dev \
    --cc=kernel-team@meta.com \
    --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