| From: SeongJae Park <sj@kernel.org> |
| Subject: Docs/mm/damon/index: add links to design |
| Date: Mon, 1 Jul 2024 12:27:05 -0700 |
| |
| 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. |
| |
| Link: https://lkml.kernel.org/r/20240701192706.51415-9-sj@kernel.org |
| Signed-off-by: SeongJae Park <sj@kernel.org> |
| Cc: Jonathan Corbet <corbet@lwn.net> |
| Signed-off-by: Andrew Morton <akpm@linux-foundation.org> |
| --- |
| |
| Documentation/mm/damon/design.rst | 1 + |
| Documentation/mm/damon/index.rst | 11 ++++++----- |
| 2 files changed, 7 insertions(+), 5 deletions(-) |
| |
| --- a/Documentation/mm/damon/design.rst~docs-mm-damon-index-add-links-to-design |
| +++ a/Documentation/mm/damon/design.rst |
| @@ -141,6 +141,7 @@ as Idle page tracking does. |
| Core Logics |
| =========== |
| |
| +.. _damon_design_monitoring: |
| |
| Monitoring |
| ---------- |
| --- a/Documentation/mm/damon/index.rst~docs-mm-damon-index-add-links-to-design |
| +++ a/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 |
| 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 |
| _ |
