leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs/admin-guide/mm/damon/usage: remove redundant information

Browse Source 
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/20211209131806.19317-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>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
SeongJae Park 2022-01-14 14:10:05 -08:00 committed by Linus Torvalds
parent 6322416b2d
commit 35b43d4092
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Documentation/admin-guide/mm/damon/usage.rst
View File

@ -7,30 +7,30 @@ Detailed Usages
DAMON provides below three interfaces for different users. DAMON provides below three interfaces for different users.
- *DAMON user space tool.* - *DAMON user space tool.*
This is for privileged people such as system administrators who want a `This <https://github.com/awslabs/damo>`_ is for privileged people such as
just-working human-friendly interface. Using this, users can use the DAMON’s system administrators who want a just-working human-friendly interface.
major features in a human-friendly way. It may not be highly tuned for Using this, users can use the DAMON’s major features in a human-friendly way.
special cases, though. It supports both virtual and physical address spaces It may not be highly tuned for special cases, though. It supports both
monitoring. virtual and physical address spaces monitoring. For more detail, please
refer to its `usage document
<https://github.com/awslabs/damo/blob/next/USAGE.md>`_.
- *debugfs interface.* - *debugfs interface.*
This is for privileged user space programmers who want more optimized use of :ref:`This <debugfs_interface>` is for privileged user space programmers who
DAMON. Using this, users can use DAMON’s major features by reading want more optimized use of DAMON. Using this, users can use DAMON’s major
from and writing to special debugfs files. Therefore, you can write and use features by reading from and writing to special debugfs files. Therefore,
your personalized DAMON debugfs wrapper programs that reads/writes the you can write and use your personalized DAMON debugfs wrapper programs that
debugfs files instead of you. The DAMON user space tool is also a reference reads/writes the debugfs files instead of you. The `DAMON user space tool
implementation of such programs. It supports both virtual and physical <https://github.com/awslabs/damo>`_ is one example of such programs. It
address spaces monitoring. supports both virtual and physical address spaces monitoring.
- *Kernel Space Programming Interface.* - *Kernel Space Programming Interface.*
This is for kernel space programmers. Using this, users can utilize every :doc:`This </vm/damon/api>` is for kernel space programmers. Using this,
feature of DAMON most flexibly and efficiently by writing kernel space users can utilize every feature of DAMON most flexibly and efficiently by
DAMON application programs for you. You can even extend DAMON for various writing kernel space DAMON application programs for you. You can even extend
address spaces. DAMON for various address spaces. For detail, please refer to the interface
:doc:`document </vm/damon/api>`.
Nevertheless, you could write your own user space tool using the debugfs
interface. A reference implementation is available at .. _debugfs_interface:
https://github.com/awslabs/damo. If you are a kernel programmer, you could
refer to :doc:`/vm/damon/api` for the kernel space programming interface. For
the reason, this document describes only the debugfs interface
debugfs Interface debugfs Interface
================= =================