diff mbox series

[bpf] doc: Add link to bpf helpers man page

Message ID 20200813180807.2821735-1-joe@wand.net.nz
State Accepted
Delegated to: BPF Maintainers
Headers show
Series [bpf] doc: Add link to bpf helpers man page | expand

Commit Message

Joe Stringer Aug. 13, 2020, 6:08 p.m. UTC
The bpf-helpers(7) man pages provide an invaluable description of the
functions that an eBPF program can call at runtime. Link them here.

Signed-off-by: Joe Stringer <joe@wand.net.nz>
---
 Documentation/bpf/index.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Martin KaFai Lau Aug. 13, 2020, 9:27 p.m. UTC | #1
On Thu, Aug 13, 2020 at 11:08:07AM -0700, Joe Stringer wrote:
> The bpf-helpers(7) man pages provide an invaluable description of the
> functions that an eBPF program can call at runtime. Link them here.
Acked-by: Martin KaFai Lau <kafai@fb.com>
Daniel Borkmann Aug. 13, 2020, 9:37 p.m. UTC | #2
On 8/13/20 8:08 PM, Joe Stringer wrote:
> The bpf-helpers(7) man pages provide an invaluable description of the
> functions that an eBPF program can call at runtime. Link them here.
> 
> Signed-off-by: Joe Stringer <joe@wand.net.nz>

Applied, thanks! (I fixed up the newlines in this paragraph to make them
consistent with the rest of this doc.)
diff mbox series

Patch

diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
index d46429be334e..7e76f0705971 100644
--- a/Documentation/bpf/index.rst
+++ b/Documentation/bpf/index.rst
@@ -35,6 +35,10 @@  Two sets of Questions and Answers (Q&A) are maintained.
    bpf_design_QA
    bpf_devel_QA
 
+Helper functions
+================
+
+* `bpf-helpers(7)`_ maintains a list of helpers available to eBPF programs.
 
 Program types
 =============
@@ -79,4 +83,5 @@  Other
 .. _networking-filter: ../networking/filter.rst
 .. _man-pages: https://www.kernel.org/doc/man-pages/
 .. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html
+.. _bpf-helpers(7): https://man7.org/linux/man-pages/man7/bpf-helpers.7.html
 .. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/