Documentation: kbuild: Add document about namespaces

-----Original Message-----
From: Adam Zerella <[email protected]>
Sent: Monday, October 07, 2019 12:03 PM
Cc: Yamada, Masahiro/山田 真弘 <[email protected]>; Michal Marek <[email protected]>; Jonathan Corbet <[email protected]>; [email protected]; Adam Zerella <[email protected]>
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

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

Signed-off-by Adam Zerella <[email protected]>

---
 Documentation/kbuild/index.rst | 1 +
 1 file changed, 1 insertion(+)

Documentation/kbuild/index.rst +1 -1

index 0f144fad99a6..5dd01997c8ed 100644
@@ -14,6 +14,7 @@ Kernel Build System
     kconfig
     makefiles
     modules
+    namespaces
 
     headers_install
 
--

2.21.0

Quoted 4 lines

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.

Quoted 6 lines · On Mon, 7 Oct 2019 04:26:24 +0000 <[email protected]> wrote:

Quoted 4 lines

Sphinx outputs the following build warning:

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

Quoted 4 lines

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