-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs/bpf: Add bpf() syscall command reference
Generate the syscall command reference from the UAPI header file and include it in the main bpf docs page. Signed-off-by: Joe Stringer <joe@cilium.io> Signed-off-by: Alexei Starovoitov <ast@kernel.org> Reviewed-by: Quentin Monnet <quentin@isovalent.com> Acked-by: Toke Høiland-Jørgensen <toke@redhat.com> Link: https://lore.kernel.org/bpf/20210302171947.2268128-15-joe@cilium.io
- Loading branch information
Joe Stringer
authored and
Alexei Starovoitov
committed
Mar 5, 2021
1 parent
accbd33
commit 6197e5b
Showing
5 changed files
with
49 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
eBPF Userspace API | ||
================== | ||
|
||
eBPF is a kernel mechanism to provide a sandboxed runtime environment in the | ||
Linux kernel for runtime extension and instrumentation without changing kernel | ||
source code or loading kernel modules. eBPF programs can be attached to various | ||
kernel subsystems, including networking, tracing and Linux security modules | ||
(LSM). | ||
|
||
For internal kernel documentation on eBPF, see Documentation/bpf/index.rst. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
syscall |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
eBPF Syscall | ||
------------ | ||
|
||
:Authors: - Alexei Starovoitov <ast@kernel.org> | ||
- Joe Stringer <joe@wand.net.nz> | ||
- Michael Kerrisk <mtk.manpages@gmail.com> | ||
|
||
The primary info for the bpf syscall is available in the `man-pages`_ | ||
for `bpf(2)`_. | ||
|
||
bpf() subcommand reference | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. kernel-doc:: include/uapi/linux/bpf.h | ||
:doc: eBPF Syscall Preamble | ||
|
||
.. kernel-doc:: include/uapi/linux/bpf.h | ||
:doc: eBPF Syscall Commands | ||
|
||
.. Links: | ||
.. _man-pages: https://www.kernel.org/doc/man-pages/ | ||
.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters