2022-07-03 13:54:36

by kernel test robot

[permalink] [raw]
Subject: [sj:damon/next 17/20] htmldocs: Documentation/admin-guide/mm/damon/guide.rst:173: WARNING: unknown document: /vm/damon/api

tree: https://git.kernel.org/pub/scm/linux/kernel/git/sj/linux.git damon/next
head: 54aa71ecf6cac755c491a1992d83437cd2240311
commit: e381a2734cd4250c0e3ab5f46cecc86ec67edb57 [17/20] Docs/DAMON: Add more docs -next doc
reproduce: make htmldocs

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <[email protected]>

All warnings (new ones prefixed by >>):

>> Documentation/admin-guide/mm/damon/guide.rst:173: WARNING: unknown document: /vm/damon/api

vim +173 Documentation/admin-guide/mm/damon/guide.rst

172
> 173 If you are a kernel space programmer, writing kernel space DAMON applications
174 using the API (refer to the :doc:`/vm/damon/api` for more detail) would be an
175 option.
176
177

--
0-DAY CI Kernel Test Service
https://01.org/lkp


2022-07-04 17:11:27

by SeongJae Park

[permalink] [raw]
Subject: Re: [sj:damon/next 17/20] htmldocs: Documentation/admin-guide/mm/damon/guide.rst:173: WARNING: unknown document: /vm/damon/api

On Sun, 3 Jul 2022 21:15:46 +0800 kernel test robot <[email protected]> wrote:

> tree: https://git.kernel.org/pub/scm/linux/kernel/git/sj/linux.git damon/=
> next
> head: 54aa71ecf6cac755c491a1992d83437cd2240311
> commit: e381a2734cd4250c0e3ab5f46cecc86ec67edb57 [17/20] Docs/DAMON: Add mo=
> re docs -next doc
> reproduce: make htmldocs
>
> If you fix the issue, kindly add following tag where applicable
> Reported-by: kernel test robot <[email protected]>
>
> All warnings (new ones prefixed by >>):
>
> >> Documentation/admin-guide/mm/damon/guide.rst:173: WARNING: unknown docum=
> ent: /vm/damon/api
>
> vim +173 Documentation/admin-guide/mm/damon/guide.rst
>
> 172
> > 173 If you are a kernel space programmer, writing kernel space DAMON applications
> 174 using the API (refer to the :doc:`/vm/damon/api` for more detail) would be an
> 175 option.
> 176
> 177

Thank you for finding this issue! I fixed this with below change.

diff --git a/Documentation/admin-guide/mm/damon/guide.rst b/Documentation/admin-guide/mm/damon/guide.rst
index a014cb99a116..e1eb92c61499 100644
--- a/Documentation/admin-guide/mm/damon/guide.rst
+++ b/Documentation/admin-guide/mm/damon/guide.rst
@@ -171,7 +171,7 @@ applies complex optimizations itself. Using this, you can make more creative
and wise optimizations.

If you are a kernel space programmer, writing kernel space DAMON applications
-using the API (refer to the :doc:`/vm/damon/api` for more detail) would be an
+using the API (refer to the :doc:`/mm/damon/api` for more detail) would be an
option.

Please note that the issue is made by a commit that only for DAMON hacking
tree, not for the mainline or other trees. So the patch wouldn't be submitted
to other mailing lists.


Thanks,
SJ

>
> --
> 0-DAY CI Kernel Test Service
> https://01.org/lkp
>