]> git.baikalelectronics.ru Git - kernel.git/commit
bpf, docs: Fix ordering of bpf documentation
authorDave Tucker <dave@dtucker.co.uk>
Fri, 12 Nov 2021 21:17:24 +0000 (21:17 +0000)
committerDaniel Borkmann <daniel@iogearbox.net>
Wed, 17 Nov 2021 22:24:01 +0000 (23:24 +0100)
commit485d2ec4aefc081a7455684e7f3a062a8cb12ec6
treed6840a831c2abad4b2f53647e0f4a3dbd455f0a7
parent79fe875f1a7eb87fbb54d60028c33e55715d5fb6
bpf, docs: Fix ordering of bpf documentation

This commit fixes the display of the BPF documentation in the sidebar
when rendered as HTML.

Before this patch, the sidebar would render as follows for some
sections:

| BPF Documentation
  |- BPF Type Format (BTF)
    |- BPF Type Format (BTF)

This was due to creating a heading in index.rst followed by
a sphinx toctree, where the file referenced carries the same
title as the section heading.

To fix this I applied a pattern that has been established in other
subfolders of Documentation:

1. Re-wrote index.rst to have a single toctree
2. Split the sections out in to their own files

Additionally maps.rst and programs.rst make use of a glob pattern to
include map_* or prog_* rst files in their toctree, meaning future map
or program type documentation will be automatically included.

Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/1a1eed800e7b9dc13b458de113a489641519b0cc.1636749493.git.dave@dtucker.co.uk
Documentation/bpf/faq.rst [new file with mode: 0644]
Documentation/bpf/helpers.rst [new file with mode: 0644]
Documentation/bpf/index.rst
Documentation/bpf/libbpf/index.rst
Documentation/bpf/maps.rst [new file with mode: 0644]
Documentation/bpf/other.rst [new file with mode: 0644]
Documentation/bpf/programs.rst [new file with mode: 0644]
Documentation/bpf/syscall_api.rst [new file with mode: 0644]
Documentation/bpf/test_debug.rst [new file with mode: 0644]