aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Documentation/bpf/faq.rst
diff options
context:
space:
mode:
authorDave Tucker <dave@dtucker.co.uk>2021-11-12 21:17:24 +0000
committerDaniel Borkmann <daniel@iogearbox.net>2021-11-17 23:24:01 +0100
commit5931d9a3d0529dc803c792a10e52f0de1d0b9991 (patch)
treed6840a831c2abad4b2f53647e0f4a3dbd455f0a7 /Documentation/bpf/faq.rst
parentbpf, docs: Rename bpf_lsm.rst to prog_lsm.rst (diff)
downloadwireguard-linux-5931d9a3d0529dc803c792a10e52f0de1d0b9991.tar.xz
wireguard-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/faq.rst')
-rw-r--r--Documentation/bpf/faq.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/bpf/faq.rst b/Documentation/bpf/faq.rst
new file mode 100644
index 000000000000..a622602ce9ad
--- /dev/null
+++ b/Documentation/bpf/faq.rst
@@ -0,0 +1,11 @@
+================================
+Frequently asked questions (FAQ)
+================================
+
+Two sets of Questions and Answers (Q&A) are maintained.
+
+.. toctree::
+ :maxdepth: 1
+
+ bpf_design_QA
+ bpf_devel_QA