Re: linux-next: build warnings after merge of the ftrace tree
From: Daniel Bristot de Oliveira
Date: Sat Jan 15 2022 - 05:02:25 EST
Hi Stephen
On 1/15/22 05:28, Stephen Rothwell wrote:
> Hi all,
>
> After merging the ftrace tree, today's linux-next build (htmldoc)
> produced these warnings:
>
> Documentation/tools/rtla/rtla-osnoise-hist.rst: WARNING: document isn't included in any toctree
> Documentation/tools/rtla/rtla-osnoise-top.rst: WARNING: document isn't included in any toctree
> Documentation/tools/rtla/rtla-timerlat.rst: WARNING: document isn't included in any toctree
> Documentation/tools/rtla/rtla-timerlat-hist.rst: WARNING: document isn't included in any toctree
> Documentation/tools/rtla/rtla-timerlat-top.rst: WARNING: document isn't included in any toctree
>
> Introduced by commits
>
> b1be48307de4 ("rtla: Add rtla osnoise top documentation")
> e7041c6b3c12 ("rtla: Add rtla osnoise hist documentation")
> 29380d4055e5 ("rtla: Add rtla timerlat documentation")
> df337d014b57 ("rtla: Add rtla timerlat top documentation")
> 5dce5904e3b9 ("rtla: Add rtla timerlat hist documentation")
>
The Documentation/tools/$tools/ is a new directory to store man pages of the
$tools. The idea seems to be to create a '"book" within the larger documentation
collection'.
I moved the documentation to that directory following Corbet's suggestion [1],
but the "book" was not yet created. I think it deserves the hands of a more
expert person in Docs.
Thoughts?
[1] https://lore.kernel.org/lkml/5796a3d5-ae98-9d28-138f-981a06dab34b@xxxxxxxxxx/
-- Daniel