Skip to content

Documenting eBPF - extended Berkeley Packet Filter

Jesper Dangaard Brouer lkml netdev 1 version In review

Get series with b4
b4 am 148647756092.10567.10947541548678801938.stgit@localhost

Versions newest first

  1. v1 Latest4 patches 9 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4doc/bpf: start eBPF documentation tree bpf/Documentation/bpf/index.rst Documentation/index.rst+67 -00 replies
2/4doc/bpf: document interacting with eBPF mapsDocumentation/bpf/ebpf_maps.rst Documentation/bpf/index.rst+257 -00 replies
3/4doc/bpf: describes the different types of eBPF maps availableDocumentation/bpf/ebpf_maps.rst Documentation/bpf/ebpf_maps_types.rst Documentation/bpf/index.rst+122 -10 replies
4/4doc/bpf: describe BCC the BPF Compiler CollectionDocumentation/bpf/bcc_tool_chain.rst Documentation/bpf/index.rst+39 -30 replies

Reviews trailers per patch

1 of 4 patches has a Reviewed-by or Acked-by.

PatchAlexander Alemayhu
1/4
2/4
3/4
4/4R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [net-next PATCH 0/4] Documenting eBPF - extended Berkeley Packet Filter

Question: What kernel tree should this go into???

If going through Jonathan Corbet, will it appear sooner here???
https://www.kernel.org/doc/html/latest/
If it will not appear sooner that way, then it's likely best to keep it in sync with the tree that takes eBPF code changes.

This marks the beginning of user-facing developer documentation for using eBPF (extended Berkeley Packet Filter) as part of the kernel Documentation/ tree.

This documentation is also available here[1], as an intermidiate quick way of prototyping and releasing the documentation. The autoriative and official version of the documentation is what gets included in the kernel tree. The docs at [2] will get updated based on what gets accepted after the standard peer-review kernel process.

[1] http://prototype-kernel.readthedocs.io/en/latest/bpf/index.html
[2] https://github.com/netoptimizer/prototype-kernel/tree/master/kernel/Documentation

Thanks to the following people, who have already reviewed and fixed earlier versions of this documentation on the IOvisor mailing-list:

Alexander Alemayhu <[email protected]>
Alexei Starovoitov <[email protected]>
Daniel Borkmann <[email protected]>
Quentin Monnet <[email protected]>

---

Jesper Dangaard Brouer (4):
doc/bpf: start eBPF documentation tree bpf/ doc/bpf: document interacting with eBPF maps doc/bpf: describes the different types of eBPF maps available doc/bpf: describe BCC the BPF Compiler Collection

 Documentation/bpf/bcc_tool_chain.rst  |   37 +++++
 Documentation/bpf/ebpf_maps.rst       |  256 +++++++++++++++++++++++++++++++++
 Documentation/bpf/ebpf_maps_types.rst |  119 +++++++++++++++
 Documentation/bpf/index.rst           |   68 +++++++++
 Documentation/index.rst               |    1 
 5 files changed, 481 insertions(+)
 create mode 100644 Documentation/bpf/bcc_tool_chain.rst
 create mode 100644 Documentation/bpf/ebpf_maps.rst
 create mode 100644 Documentation/bpf/ebpf_maps_types.rst
 create mode 100644 Documentation/bpf/index.rst

--