mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git
synced 2026-04-04 04:37:39 -04:00
a592a36e49
The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
39 lines
783 B
ReStructuredText
39 lines
783 B
ReStructuredText
=================
|
|
BPF Documentation
|
|
=================
|
|
|
|
This directory contains documentation for the BPF (Berkeley Packet
|
|
Filter) facility, with a focus on the extended BPF version (eBPF).
|
|
|
|
This kernel side documentation is still work in progress.
|
|
The Cilium project also maintains a `BPF and XDP Reference Guide`_
|
|
that goes into great technical depth about the BPF Architecture.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
verifier
|
|
libbpf/index
|
|
standardization/index
|
|
btf
|
|
faq
|
|
syscall_api
|
|
helpers
|
|
kfuncs
|
|
cpumasks
|
|
fs_kfuncs
|
|
programs
|
|
maps
|
|
bpf_prog_run
|
|
classic_vs_extended.rst
|
|
bpf_iterators
|
|
bpf_licensing
|
|
test_debug
|
|
clang-notes
|
|
linux-notes
|
|
other
|
|
redirect
|
|
|
|
.. Links:
|
|
.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
|