| From: SeongJae Park <sj@kernel.org> |
| Subject: Docs/admin-guide/mm/damon/usage: link damos stat design doc |
| Date: Mon, 6 Jan 2025 11:33:48 -0800 |
| |
| 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. |
| |
| Link: https://lkml.kernel.org/r/20250106193401.109161-4-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/admin-guide/mm/damon/usage.rst | 3 ++- |
| Documentation/mm/damon/design.rst | 2 ++ |
| 2 files changed, 4 insertions(+), 1 deletion(-) |
| |
| --- a/Documentation/admin-guide/mm/damon/usage.rst~docs-admin-guide-mm-damon-usage-link-damos-stat-design-doc |
| +++ a/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 |
| --- a/Documentation/mm/damon/design.rst~docs-admin-guide-mm-damon-usage-link-damos-stat-design-doc |
| +++ a/Documentation/mm/damon/design.rst |
| @@ -539,6 +539,8 @@ To know how user-space can set the water |
| <sysfs_interface>`, refer to :ref:`filters <sysfs_filters>` part of the |
| documentation. |
| |
| +.. _damon_design_damos_stat: |
| + |
| Statistics |
| ~~~~~~~~~~ |
| |
| _ |
