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-mm@kvack.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 8/9] Docs/mm/damon/index: add links to design
Date: Mon, 1 Jul 2024 12:27:05 -0700 [thread overview]
Message-ID: <20240701192706.51415-9-sj@kernel.org> (raw)
In-Reply-To: <20240701192706.51415-1-sj@kernel.org>
DAMON subsystem documents index page provides a short intro of DAMON
core concepts. Add links to sections of the design document to let
users easily browse to the details.
Signed-off-by: SeongJae Park <sj@kernel.org>
---
Documentation/mm/damon/design.rst | 1 +
Documentation/mm/damon/index.rst | 11 ++++++-----
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index 89f5330e003f..8730c246ceaa 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -141,6 +141,7 @@ as Idle page tracking does.
Core Logics
===========
+.. _damon_design_monitoring:
Monitoring
----------
diff --git a/Documentation/mm/damon/index.rst b/Documentation/mm/damon/index.rst
index 5e0a50583500..3d3b345d8889 100644
--- a/Documentation/mm/damon/index.rst
+++ b/Documentation/mm/damon/index.rst
@@ -6,7 +6,7 @@ DAMON: Data Access MONitor
DAMON is a Linux kernel subsystem that provides a framework for data access
monitoring and the monitoring results based system operations. The core
-monitoring mechanisms of DAMON (refer to :doc:`design` for the detail) make it
+monitoring :ref:`mechanisms <damon_design_monitoring>` of DAMON make it
- *accurate* (the monitoring output is useful enough for DRAM level memory
management; It might not appropriate for CPU Cache levels, though),
@@ -21,10 +21,11 @@ users who have special information about their workloads can write personalized
applications for better understanding and optimizations of their workloads and
systems.
-For easier development of such systems, DAMON provides a feature called DAMOS
-(DAMon-based Operation Schemes) in addition to the monitoring. Using the
-feature, DAMON users in both kernel and user spaces can do access-aware system
-operations with no code but simple configurations.
+For easier development of such systems, DAMON provides a feature called
+:ref:`DAMOS <damon_design_damos>` (DAMon-based Operation Schemes) in addition
+to the monitoring. Using the feature, DAMON users in both kernel and user
+spaces can do access-aware system operations with no code but simple
+configurations.
.. toctree::
:maxdepth: 2
--
2.39.2
next prev parent reply other threads:[~2024-07-01 19:27 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-01 19:26 [PATCH 0/9] Docs/damon: minor fixups and improvements SeongJae Park
2024-07-01 19:26 ` [PATCH 1/9] Docs/mm/damon/design: fix two typos SeongJae Park
2024-07-01 19:26 ` [PATCH 2/9] Docs/mm/damon/design: clarify regions merging operation SeongJae Park
2024-07-01 19:27 ` [PATCH 3/9] Docs/admin-guide/mm/damon/start: add access pattern snapshot example SeongJae Park
2024-07-01 19:27 ` [PATCH 4/9] Docs/mm/damon/design: add links from overall architecture to sections of details SeongJae Park
2024-07-01 19:27 ` [PATCH 5/9] Docs/mm/damon/design: move 'Configurable Operations Set' section into 'Operations Set Layer' section SeongJae Park
2024-07-01 19:27 ` [PATCH 6/9] Docs/mm/damon/design: Remove 'Programmable Modules' section in favor of 'Modules' section SeongJae Park
2024-07-01 19:27 ` [PATCH 7/9] Docs/mm/damon/design: add links to sections of DAMON sysfs interface usage doc SeongJae Park
2024-07-01 19:27 ` SeongJae Park [this message]
2024-07-01 19:27 ` [PATCH 9/9] Docs/mm/damon/index: add links to admin-guide doc 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=20240701192706.51415-9-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;
as well as URLs for NNTP newsgroup(s).