Skip to contentSkip to conversation

Documentation: bpf: Add implementation notes documentations to table of contents

PATCH Applied Bagas Sanjaya 2 participants 2 messages Oct 2, 2022 – Oct 3, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: bpf: Add implementation notes documentations to table of contents

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.

Fixes 6c7aaffb24efbd ("bpf, docs: Move Clang notes to a separate file")
Fixes 6166da0a02cde2 ("bpf, docs: Move legacy packet instructions to a separate file")

---
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(+)
Documentation/bpf/index.rst +2 -0
index 1bc2c5c58bdbdc..1b50de1983ee2c 100644
@@ -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

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw
This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:

Hello:

This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:

Quoted 10 lines · 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!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html