[PATCH bpf-next] Documentation: bpf: Add implementation notes documentations to table of contents

Bagas Sanjaya posted 1 patch 3 years, 6 months ago
Documentation/bpf/index.rst | 2 ++
1 file changed, 2 insertions(+)
[PATCH bpf-next] Documentation: bpf: Add implementation notes documentations to table of contents
Posted by Bagas Sanjaya 3 years, 6 months ago
Sphinx reported warnings on missing implementation notes documentations in the
table of contents:

Documentation/bpf/clang-notes.rst: WARNING: document isn't included in any toctree
Documentation/bpf/linux-notes.rst: WARNING: document isn't included in any toctree

Add these documentations to the table of contents (index.rst) of BPF
documentation to fix the warnings.

Link: https://lore.kernel.org/linux-doc/202210020749.yfgDZbRL-lkp@intel.com/
Fixes: 6c7aaffb24efbd ("bpf, docs: Move Clang notes to a separate file")
Fixes: 6166da0a02cde2 ("bpf, docs: Move legacy packet instructions to a separate file")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Hi bpf maintainers,

 This is last-minute fix due to upcoming merge window that will be open
 shortly on the next week.

 Documentation/bpf/index.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
index 1bc2c5c58bdbdc..1b50de1983ee2c 100644
--- a/Documentation/bpf/index.rst
+++ b/Documentation/bpf/index.rst
@@ -26,6 +26,8 @@ that goes into great technical depth about the BPF Architecture.
    classic_vs_extended.rst
    bpf_licensing
    test_debug
+   clang-notes
+   linux-notes
    other
 
 .. only::  subproject and html

base-commit: b502a6fb46d275aa978c1e0655bada2cafc81fea
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH bpf-next] Documentation: bpf: Add implementation notes documentations to table of contents
Posted by patchwork-bot+netdevbpf@kernel.org 3 years, 6 months ago
Hello:

This patch was applied to bpf/bpf-next.git (master)
by Alexei Starovoitov <ast@kernel.org>:

On Sun,  2 Oct 2022 10:20:23 +0700 you wrote:
> Sphinx reported warnings on missing implementation notes documentations in the
> table of contents:
> 
> Documentation/bpf/clang-notes.rst: WARNING: document isn't included in any toctree
> Documentation/bpf/linux-notes.rst: WARNING: document isn't included in any toctree
> 
> Add these documentations to the table of contents (index.rst) of BPF
> documentation to fix the warnings.
> 
> [...]

Here is the summary with links:
  - [bpf-next] Documentation: bpf: Add implementation notes documentations to table of contents
    https://git.kernel.org/bpf/bpf-next/c/736baae643cb

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html