Re: [PATCH v24 11/14] Documentation: Add documents for DAMON

SeongJae Park
2021-02-24T07:52:07Z

On Thu, 4 Feb 2021 16:31:47 +0100 SeongJae Park <sjpark@amazon.com> wrote:

> From: SeongJae Park <sjpark@amazon.de>
>
> This commit adds documents for DAMON under
> `Documentation/admin-guide/mm/damon/` and `Documentation/vm/damon/`.
>
> Signed-off-by: SeongJae Park <sjpark@amazon.de>
> ---
> Documentation/admin-guide/mm/damon/guide.rst | 159 ++++++++++
> Documentation/admin-guide/mm/damon/index.rst | 15 +
> Documentation/admin-guide/mm/damon/plans.rst | 29 ++
> Documentation/admin-guide/mm/damon/start.rst | 97 ++++++
> Documentation/admin-guide/mm/damon/usage.rst | 304 +++++++++++++++++++
> Documentation/admin-guide/mm/index.rst | 1 +
> Documentation/vm/damon/api.rst | 20 ++
> Documentation/vm/damon/design.rst | 166 ++++++++++
> Documentation/vm/damon/eval.rst | 232 ++++++++++++++
> Documentation/vm/damon/faq.rst | 58 ++++
> Documentation/vm/damon/index.rst | 31 ++
> Documentation/vm/index.rst | 1 +
> 12 files changed, 1113 insertions(+)
> create mode 100644 Documentation/admin-guide/mm/damon/guide.rst
> create mode 100644 Documentation/admin-guide/mm/damon/index.rst
> create mode 100644 Documentation/admin-guide/mm/damon/plans.rst
> create mode 100644 Documentation/admin-guide/mm/damon/start.rst
> create mode 100644 Documentation/admin-guide/mm/damon/usage.rst
> create mode 100644 Documentation/vm/damon/api.rst
> create mode 100644 Documentation/vm/damon/design.rst
> create mode 100644 Documentation/vm/damon/eval.rst
> create mode 100644 Documentation/vm/damon/faq.rst
> create mode 100644 Documentation/vm/damon/index.rst
>
[...]
> diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> new file mode 100644
> index 000000000000..32436cf853c7
> --- /dev/null
> +++ b/Documentation/admin-guide/mm/damon/usage.rst
> @@ -0,0 +1,304 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===============
> +Detailed Usages
> +===============
> +
> +DAMON provides below three interfaces for different users.
> +
> +- *DAMON user space tool.*
> + This is for privileged people such as system administrators who want a
> + just-working human-friendly interface. Using this, users can use the DAMON’s
> + major features in a human-friendly way. It may not be highly tuned for
> + special cases, though. It supports only virtual address spaces monitoring.
> +- *debugfs interface.*
> + This is for privileged user space programmers who want more optimized use of
> + DAMON. Using this, users can use DAMON’s major features by reading
> + from and writing to special debugfs files. Therefore, you can write and use
> + your personalized DAMON debugfs wrapper programs that reads/writes the
> + debugfs files instead of you. The DAMON user space tool is also a reference
> + implementation of such programs. It supports only virtual address spaces
> + monitoring.
> +- *Kernel Space Programming Interface.*
> + This is for kernel space programmers. Using this, users can utilize every
> + feature of DAMON most flexibly and efficiently by writing kernel space
> + DAMON application programs for you. You can even extend DAMON for various
> + address spaces.
> +
> +This document does not describe the kernel space programming interface in
> +detail. For that, please refer to the :doc:`/vm/damon/api`.
> +
> +
> +DAMON User Space Tool
> +=====================

This version of the patchset doesn't introduce the user space tool source code,
so putting the detailed usage here might make no sense. I will remove this
section in the next version. If you will review this patch, please skip this
section.
[...]
> +
> +debugfs Interface
> +=================

But, this section will not be removed. Please review.

[...]

Thanks,
SeongJae Park