Re: Re: [RFC PATCH 4/5] Documentation/admin-guide/mm: Add a document for DAMON

[SeongJae Park <sj38.park@gmail.com>]

On Thu, 23 Jan 2020 13:17:04 -0800 Brendan Higgins <brendanhiggins@google.com> wrote:

> On Fri, Jan 10, 2020 at 5:16 AM SeongJae Park <sjpark@amazon.com> wrote:
> >
> > From: SeongJae Park <sjpark@amazon.de>
> >
> > This commit adds a simple document for DAMON under
> > 'Documentation/admin-guide/mm/'.
> >
> > Signed-off-by: SeongJae Park <sjpark@amazon.de>
> > ---
> >  .../admin-guide/mm/data_access_monitor.rst    | 235 ++++++++++++++++++
> >  Documentation/admin-guide/mm/index.rst        |   1 +
> >  2 files changed, 236 insertions(+)
> >  create mode 100644 Documentation/admin-guide/mm/data_access_monitor.rst
> >
> > diff --git a/Documentation/admin-guide/mm/data_access_monitor.rst b/Documentation/admin-guide/mm/data_access_monitor.rst
> > new file mode 100644
> > index 000000000000..907a7af75f35
> > --- /dev/null
> > +++ b/Documentation/admin-guide/mm/data_access_monitor.rst
> > @@ -0,0 +1,235 @@
> > +.. _data_access_monitor:
> > +
> > +==========================
> > +DAMON: Data Access MONitor
> > +==========================
> > +
> > +
[...]
> > +
> > +Quick Tutorial
> > +--------------
> > +
> > +To test DAMON on your system,
> > +
> > +1. Ensure your kernel is built with CONFIG_DAMON turned on, and debugfs is
> > +   mounted at ``/sys/kernel/debug/``.
> > +2. ``<your kernel source tree>/tools/damon/damn -h``
> 
> I think it would be helpful for the reader to provide an example of
> what they should expect to see here.

Totally agreed.

Will apply your suggestion by next spin.


Thanks,
SeongJae Park

> 
> > diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
> > index 11db46448354..d3d0ba373eb6 100644
> > --- a/Documentation/admin-guide/mm/index.rst
> > +++ b/Documentation/admin-guide/mm/index.rst
> > @@ -27,6 +27,7 @@ the Linux memory management.
> >
> >     concepts
> >     cma_debugfs
> > +   data_access_monitor
> >     hugetlbpage
> >     idle_page_tracking
> >     ksm
> > --
> > 2.17.1
> >