mirror of
https://github.com/torvalds/linux.git
synced 2024-12-27 05:11:48 +00:00
736baae643
Sphinx reported warnings on missing implementation notes documentations in the table of contents: Documentation/bpf/clang-notes.rst: WARNING: document isn't included in any toctree Documentation/bpf/linux-notes.rst: WARNING: document isn't included in any toctree Add these documentations to the table of contents (index.rst) of BPF documentation to fix the warnings. Link: https://lore.kernel.org/linux-doc/202210020749.yfgDZbRL-lkp@intel.com/ Fixes:6c7aaffb24("bpf, docs: Move Clang notes to a separate file") Fixes:6166da0a02("bpf, docs: Move legacy packet instructions to a separate file") Reported-by: kernel test robot <lkp@intel.com> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20221002032022.24693-1-bagasdotme@gmail.com Signed-off-by: Alexei Starovoitov <ast@kernel.org>
42 lines
800 B
ReStructuredText
42 lines
800 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
|
|
|
|
instruction-set
|
|
verifier
|
|
libbpf/index
|
|
btf
|
|
faq
|
|
syscall_api
|
|
helpers
|
|
kfuncs
|
|
programs
|
|
maps
|
|
bpf_prog_run
|
|
classic_vs_extended.rst
|
|
bpf_licensing
|
|
test_debug
|
|
clang-notes
|
|
linux-notes
|
|
other
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|
|
|
|
.. Links:
|
|
.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
|