Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Tue, 7 Jul 2020 10:49:06 +0300
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
Message-ID: <20200707074906.GC9449@kernel.org>
References: <20200706115322.29598-1-sjpark@amazon.com>
 <20200706115322.29598-13-sjpark@amazon.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20200706115322.29598-13-sjpark@amazon.com>
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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.