From: Mike Rapoport <rppt@kernel.org>
To: SeongJae Park <sjpark@amazon.com>
Cc: akpm@linux-foundation.org, SeongJae Park <sjpark@amazon.de>,
Jonathan.Cameron@huawei.com, aarcange@redhat.com,
acme@kernel.org, alexander.shishkin@linux.intel.com,
amit@kernel.org, benh@kernel.crashing.org,
brendan.d.gregg@gmail.com, brendanhiggins@google.com, cai@lca.pw,
colin.king@canonical.com, corbet@lwn.net, dwmw@amazon.com,
foersleo@amazon.de, irogers@google.com, jolsa@redhat.com,
kirill@shutemov.name, mark.rutland@arm.com, mgorman@suse.de,
minchan@kernel.org, mingo@redhat.com, namhyung@kernel.org,
peterz@infradead.org, rdunlap@infradead.org, riel@surriel.com,
rientjes@google.com, rostedt@goodmis.org, sblbir@amazon.com,
shakeelb@google.com, shuah@kernel.org, sj38.park@gmail.com,
snu@amazon.de, vbabka@suse.cz, vdavydov.dev@gmail.com,
yang.shi@linux.alibaba.com, ying.huang@intel.com,
david@redhat.com, linux-damon@amazon.com, linux-mm@kvack.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v17 12/15] Documentation/admin-guide/mm: Add a document for DAMON
Date: Tue, 7 Jul 2020 10:49:06 +0300 [thread overview]
Message-ID: <20200707074906.GC9449@kernel.org> (raw)
In-Reply-To: <20200706115322.29598-13-sjpark@amazon.com>
Hello SeongJae,
On Mon, Jul 06, 2020 at 01:53:19PM +0200, SeongJae Park wrote:
> From: SeongJae Park <sjpark@amazon.de>
>
> This commit adds a document for DAMON under
> `Documentation/admin-guide/mm/damon/`.
>
> Signed-off-by: SeongJae Park <sjpark@amazon.de>
> ---
> Documentation/admin-guide/mm/damon/api.rst | 20 ++
> .../admin-guide/mm/damon/damon_heatmap.png | Bin 0 -> 8366 bytes
> .../admin-guide/mm/damon/damon_wss_change.png | Bin 0 -> 7211 bytes
> .../admin-guide/mm/damon/damon_wss_dist.png | Bin 0 -> 6173 bytes
> Documentation/admin-guide/mm/damon/eval.rst | 222 +++++++++++++
> Documentation/admin-guide/mm/damon/faq.rst | 59 ++++
> .../admin-guide/mm/damon/freqmine_heatmap.png | Bin 0 -> 9999 bytes
> .../admin-guide/mm/damon/freqmine_wss_sz.png | Bin 0 -> 5589 bytes
> .../mm/damon/freqmine_wss_time.png | Bin 0 -> 6550 bytes
> Documentation/admin-guide/mm/damon/guide.rst | 194 ++++++++++++
> Documentation/admin-guide/mm/damon/index.rst | 35 +++
> .../admin-guide/mm/damon/mechanisms.rst | 159 ++++++++++
> Documentation/admin-guide/mm/damon/plans.rst | 29 ++
> Documentation/admin-guide/mm/damon/start.rst | 117 +++++++
> .../mm/damon/streamcluster_heatmap.png | Bin 0 -> 42210 bytes
> .../mm/damon/streamcluster_wss_sz.png | Bin 0 -> 6327 bytes
> .../mm/damon/streamcluster_wss_time.png | Bin 0 -> 8830 bytes
> Documentation/admin-guide/mm/damon/usage.rst | 296 ++++++++++++++++++
> Documentation/admin-guide/mm/index.rst | 1 +
It's really cool to see documentation along with the code!
I'd suggest to reorganize the DAMON docs to better match the current
structure of Documentation/ directory.
The description of DAMON usage from the userspace and reference for the
userland tools does belong to Documentation/admin-guide/mm. However, the
kernel APIs are better to be placed in Documentation/core-api or even
Documentation/dev-tools. As for the detailed description of the internal
DAMON operation, this would naturally belong to Documentation/vm.
Another thing is that this patch is really hard to review because of the
encoded png blobs. In general, we try to keep Documentation/ readable in
plain text, but if you think that the images are essential and must be a
part of DAMON in-tree docs rather than links to an external resource,
please split them to a separate patch.
--
Sincerely yours,
Mike.
next prev parent reply other threads:[~2020-07-07 7:49 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-06 11:53 [PATCH v17 00/15] Introduce Data Access MONitor (DAMON) SeongJae Park
2020-07-06 11:53 ` [PATCH v17 01/15] mm/page_ext: Export lookup_page_ext() to GPL modules SeongJae Park
2020-07-06 11:53 ` [PATCH v17 02/15] mm: Introduce Data Access MONitor (DAMON) SeongJae Park
2020-07-06 11:53 ` [PATCH v17 03/15] mm/damon: Implement region based sampling SeongJae Park
2020-07-07 7:54 ` SeongJae Park
2020-07-06 11:53 ` [PATCH v17 04/15] mm/damon: Adaptively adjust regions SeongJae Park
2020-07-06 11:53 ` [PATCH v17 05/15] mm/damon: Track dynamic monitoring target regions update SeongJae Park
2020-07-06 11:53 ` [PATCH v17 06/15] mm/damon: Implement callbacks for the virtual memory address spaces SeongJae Park
2020-07-06 11:53 ` [PATCH v17 07/15] mm/damon: Implement access pattern recording SeongJae Park
2020-07-06 11:53 ` [PATCH v17 08/15] mm/damon: Add a tracepoint SeongJae Park
2020-07-06 11:53 ` [PATCH v17 09/15] mm/damon: Implement a debugfs interface SeongJae Park
2020-07-06 11:53 ` [PATCH v17 10/15] tools: Introduce a minimal user-space tool for DAMON SeongJae Park
2020-07-06 11:53 ` [PATCH v17 11/15] tools/damon/wss: Implement '--thres' option SeongJae Park
2020-07-06 15:04 ` SeongJae Park
2020-07-06 11:53 ` [PATCH v17 12/15] Documentation/admin-guide/mm: Add a document for DAMON SeongJae Park
2020-07-07 7:49 ` Mike Rapoport [this message]
2020-07-07 8:07 ` SeongJae Park
2020-07-06 11:53 ` [PATCH v17 13/15] mm/damon: Add kunit tests SeongJae Park
2020-07-06 11:53 ` [PATCH v17 14/15] mm/damon: Add user space selftests SeongJae Park
2020-07-06 11:53 ` [PATCH v17 15/15] MAINTAINERS: Update for DAMON SeongJae Park
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200707074906.GC9449@kernel.org \
--to=rppt@kernel.org \
--cc=Jonathan.Cameron@huawei.com \
--cc=aarcange@redhat.com \
--cc=acme@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=alexander.shishkin@linux.intel.com \
--cc=amit@kernel.org \
--cc=benh@kernel.crashing.org \
--cc=brendan.d.gregg@gmail.com \
--cc=brendanhiggins@google.com \
--cc=cai@lca.pw \
--cc=colin.king@canonical.com \
--cc=corbet@lwn.net \
--cc=david@redhat.com \
--cc=dwmw@amazon.com \
--cc=foersleo@amazon.de \
--cc=irogers@google.com \
--cc=jolsa@redhat.com \
--cc=kirill@shutemov.name \
--cc=linux-damon@amazon.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mark.rutland@arm.com \
--cc=mgorman@suse.de \
--cc=minchan@kernel.org \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
--cc=rdunlap@infradead.org \
--cc=riel@surriel.com \
--cc=rientjes@google.com \
--cc=rostedt@goodmis.org \
--cc=sblbir@amazon.com \
--cc=shakeelb@google.com \
--cc=shuah@kernel.org \
--cc=sj38.park@gmail.com \
--cc=sjpark@amazon.com \
--cc=sjpark@amazon.de \
--cc=snu@amazon.de \
--cc=vbabka@suse.cz \
--cc=vdavydov.dev@gmail.com \
--cc=yang.shi@linux.alibaba.com \
--cc=ying.huang@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).