linux-xiaomi-chiron/Documentation/bpf/syscall_api.rst

===========
Syscall API
===========

The primary info for the bpf syscall is available in the `man-pages`_
for `bpf(2)`_. For more information about the userspace API, see
Documentation/userspace-api/ebpf/index.rst.

.. Links:
.. _man-pages: https://www.kernel.org/doc/man-pages/
.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html
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 2021-11-12 21:17:24 +00:00			`===========`
			`Syscall API`
			`===========`

			The primary info for the bpf syscall is available in the `man-pages`_
			for `bpf(2)`_. For more information about the userspace API, see
			`Documentation/userspace-api/ebpf/index.rst.`

			`.. Links:`
			`.. _man-pages: https://www.kernel.org/doc/man-pages/`
			`.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html`