diff options
author | Dave Tucker <dave@dtucker.co.uk> | 2021-11-12 21:17:24 +0000 |
---|---|---|
committer | Daniel Borkmann <daniel@iogearbox.net> | 2021-11-17 23:24:01 +0100 |
commit | 5931d9a3d0529dc803c792a10e52f0de1d0b9991 (patch) | |
tree | d6840a831c2abad4b2f53647e0f4a3dbd455f0a7 /Documentation/bpf/libbpf | |
parent | f5b1c2ef43d79e054f471dc96996ac40bb262d8d (diff) | |
download | linux-stable-5931d9a3d0529dc803c792a10e52f0de1d0b9991.tar.gz linux-stable-5931d9a3d0529dc803c792a10e52f0de1d0b9991.tar.bz2 linux-stable-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/libbpf')
-rw-r--r-- | Documentation/bpf/libbpf/index.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/bpf/libbpf/index.rst b/Documentation/bpf/libbpf/index.rst index 4f8adfc3ab83..4e8c656b539a 100644 --- a/Documentation/bpf/libbpf/index.rst +++ b/Documentation/bpf/libbpf/index.rst @@ -3,8 +3,6 @@ libbpf ====== -For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_. - .. toctree:: :maxdepth: 1 @@ -14,6 +12,8 @@ For API documentation see the `versioned API documentation site <https://libbpf. This is documentation for libbpf, a userspace library for loading and interacting with bpf programs. +For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_. + All general BPF questions, including kernel functionality, libbpf APIs and their application, should be sent to bpf@vger.kernel.org mailing list. You can `subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the |