[PATCH] Documentation: kbuild: Add document about namespaces

[PATCH] Documentation: kbuild: Add document about namespaces

[Adam Zerella]

Sphinx outputs the following build warning:

Documentation/kbuild/namespaces.rst:
WARNING: document isn't included in any toctree

Assuming this document is intended to be referenced within the
documentation it should be inside the toctree.

Signed-off-by: Adam Zerella <adam.zerella@gmail.com>
---
 Documentation/kbuild/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/kbuild/index.rst b/Documentation/kbuild/index.rst
index 0f144fad99a6..5dd01997c8ed 100644
--- a/Documentation/kbuild/index.rst
+++ b/Documentation/kbuild/index.rst
@@ -14,6 +14,7 @@ Kernel Build System
     kconfig
     makefiles
     modules
+    namespaces
 
     headers_install
 
-- 
2.21.0

RE: [PATCH] Documentation: kbuild: Add document about namespaces

[yamada.masahiro]

Hi Adam,

> -----Original Message-----
> From: Adam Zerella <adam.zerella@gmail.com>
> Sent: Monday, October 07, 2019 12:03 PM
> Cc: Yamada, Masahiro/山田 真弘 <yamada.masahiro@socionext.com>;
> Michal Marek <michal.lkml@markovi.net>; Jonathan Corbet
> <corbet@lwn.net>; linux-doc@vger.kernel.org; Adam Zerella
> <adam.zerella@gmail.com>
> Subject: [PATCH] Documentation: kbuild: Add document about namespaces
> 
> Sphinx outputs the following build warning:
> 
> Documentation/kbuild/namespaces.rst:
> WARNING: document isn't included in any toctree


Oh, I did not notice this file was added to the kbuild directory.

I do not understand why it is related to the build system.
So, I'd rather have this file somewhere else.


Thanks.


> Assuming this document is intended to be referenced within the
> documentation it should be inside the toctree.
> 
> Signed-off-by: Adam Zerella <adam.zerella@gmail.com>
> ---
>  Documentation/kbuild/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/kbuild/index.rst
> b/Documentation/kbuild/index.rst
> index 0f144fad99a6..5dd01997c8ed 100644
> --- a/Documentation/kbuild/index.rst
> +++ b/Documentation/kbuild/index.rst
> @@ -14,6 +14,7 @@ Kernel Build System
>      kconfig
>      makefiles
>      modules
> +    namespaces
> 
>      headers_install
> 
> --
> 2.21.0

Re: [PATCH] Documentation: kbuild: Add document about namespaces

[Jonathan Corbet]

On Mon, 7 Oct 2019 04:26:24 +0000
<yamada.masahiro@socionext.com> wrote:

> > Sphinx outputs the following build warning:
> > 
> > Documentation/kbuild/namespaces.rst:
> > WARNING: document isn't included in any toctree  
> 
> 
> Oh, I did not notice this file was added to the kbuild directory.
> 
> I do not understand why it is related to the build system.
> So, I'd rather have this file somewhere else.

Yeah, probably it makes sense to move it into the core-api manual.
Matthias (added to CC) do you disagree?  If not, maybe Adam you could redo
the patch with the move as well?

Thanks,

jon

Re: [PATCH] Documentation: kbuild: Add document about namespaces

[Matthias Maennich]

On Mon, Oct 07, 2019 at 07:25:38AM -0600, Jonathan Corbet wrote:
>On Mon, 7 Oct 2019 04:26:24 +0000
><yamada.masahiro@socionext.com> wrote:
>
>> > Sphinx outputs the following build warning:
>> >
>> > Documentation/kbuild/namespaces.rst:
>> > WARNING: document isn't included in any toctree
>>
>>
>> Oh, I did not notice this file was added to the kbuild directory.
>>
>> I do not understand why it is related to the build system.
>> So, I'd rather have this file somewhere else.
>
>Yeah, probably it makes sense to move it into the core-api manual.
>Matthias (added to CC) do you disagree?  If not, maybe Adam you could redo
>the patch with the move as well?

I am happy to follow a good suggestion as I wasn't sure about the
location in the first place.

Cheers,
Matthias

>
>Thanks,
>
>jon