diff options
| author | Dave Tucker <dave@dtucker.co.uk> | 2021-11-12 22:17:24 +0100 |
|---|---|---|
| committer | Daniel Borkmann <daniel@iogearbox.net> | 2021-11-17 23:24:01 +0100 |
| commit | 5931d9a3d0529dc803c792a10e52f0de1d0b9991 (patch) | |
| tree | d6840a831c2abad4b2f53647e0f4a3dbd455f0a7 /Documentation/bpf/helpers.rst | |
| parent | bpf, docs: Rename bpf_lsm.rst to prog_lsm.rst (diff) | |
| download | linux-5931d9a3d0529dc803c792a10e52f0de1d0b9991.tar.xz linux-5931d9a3d0529dc803c792a10e52f0de1d0b9991.zip | |
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
Diffstat (limited to 'Documentation/bpf/helpers.rst')
| -rw-r--r-- | Documentation/bpf/helpers.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/bpf/helpers.rst b/Documentation/bpf/helpers.rst new file mode 100644 index 000000000000..c4ee0cc20dec --- /dev/null +++ b/Documentation/bpf/helpers.rst @@ -0,0 +1,7 @@ +Helper functions +================ + +* `bpf-helpers(7)`_ maintains a list of helpers available to eBPF programs. + +.. Links +.. _bpf-helpers(7): https://man7.org/linux/man-pages/man7/bpf-helpers.7.html
\ No newline at end of file |