mirror of
https://github.com/torvalds/linux.git
synced 2024-11-26 06:02:05 +00:00
5931d9a3d0
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 |
||
---|---|---|
.. | ||
libbpf | ||
bpf_design_QA.rst | ||
bpf_devel_QA.rst | ||
bpf_licensing.rst | ||
btf.rst | ||
drgn.rst | ||
faq.rst | ||
helpers.rst | ||
index.rst | ||
llvm_reloc.rst | ||
map_cgroup_storage.rst | ||
maps.rst | ||
other.rst | ||
prog_cgroup_sockopt.rst | ||
prog_cgroup_sysctl.rst | ||
prog_flow_dissector.rst | ||
prog_lsm.rst | ||
prog_sk_lookup.rst | ||
programs.rst | ||
ringbuf.rst | ||
s390.rst | ||
syscall_api.rst | ||
test_debug.rst |