Skip to content

Commit 35b43d4

Browse files
sjp38torvalds
authored andcommitted
Docs/admin-guide/mm/damon/usage: remove redundant information
DAMON usage document mentions DAMON user space tool and programming interface twice. This commit integrates those and remove unnecessary part. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: SeongJae Park <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
1 parent 6322416 commit 35b43d4

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

Documentation/admin-guide/mm/damon/usage.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,30 @@ Detailed Usages
77
DAMON provides below three interfaces for different users.
88

99
- *DAMON user space tool.*
10-
This is for privileged people such as system administrators who want a
11-
just-working human-friendly interface. Using this, users can use the DAMON’s
12-
major features in a human-friendly way. It may not be highly tuned for
13-
special cases, though. It supports both virtual and physical address spaces
14-
monitoring.
10+
`This <https://github.com/awslabs/damo>`_ is for privileged people such as
11+
system administrators who want a just-working human-friendly interface.
12+
Using this, users can use the DAMON’s major features in a human-friendly way.
13+
It may not be highly tuned for special cases, though. It supports both
14+
virtual and physical address spaces monitoring. For more detail, please
15+
refer to its `usage document
16+
<https://github.com/awslabs/damo/blob/next/USAGE.md>`_.
1517
- *debugfs interface.*
16-
This is for privileged user space programmers who want more optimized use of
17-
DAMON. Using this, users can use DAMON’s major features by reading
18-
from and writing to special debugfs files. Therefore, you can write and use
19-
your personalized DAMON debugfs wrapper programs that reads/writes the
20-
debugfs files instead of you. The DAMON user space tool is also a reference
21-
implementation of such programs. It supports both virtual and physical
22-
address spaces monitoring.
18+
:ref:`This <debugfs_interface>` is for privileged user space programmers who
19+
want more optimized use of DAMON. Using this, users can use DAMON’s major
20+
features by reading from and writing to special debugfs files. Therefore,
21+
you can write and use your personalized DAMON debugfs wrapper programs that
22+
reads/writes the debugfs files instead of you. The `DAMON user space tool
23+
<https://github.com/awslabs/damo>`_ is one example of such programs. It
24+
supports both virtual and physical address spaces monitoring.
2325
- *Kernel Space Programming Interface.*
24-
This is for kernel space programmers. Using this, users can utilize every
25-
feature of DAMON most flexibly and efficiently by writing kernel space
26-
DAMON application programs for you. You can even extend DAMON for various
27-
address spaces.
28-
29-
Nevertheless, you could write your own user space tool using the debugfs
30-
interface. A reference implementation is available at
31-
https://github.com/awslabs/damo. If you are a kernel programmer, you could
32-
refer to :doc:`/vm/damon/api` for the kernel space programming interface. For
33-
the reason, this document describes only the debugfs interface
26+
:doc:`This </vm/damon/api>` is for kernel space programmers. Using this,
27+
users can utilize every feature of DAMON most flexibly and efficiently by
28+
writing kernel space DAMON application programs for you. You can even extend
29+
DAMON for various address spaces. For detail, please refer to the interface
30+
:doc:`document </vm/damon/api>`.
31+
32+
33+
.. _debugfs_interface:
3434

3535
debugfs Interface
3636
=================

0 commit comments

Comments
 (0)