From ef1541737fce03ad88d8d1eb7c4a2fc07b1245e1 Mon Sep 17 00:00:00 2001 From: Jesper Dangaard Brouer Date: Fri, 14 Jun 2019 09:19:12 +0200 Subject: [PATCH] Add README in kernel/samples/bpf/ Trying to get people to notice the XDP-tutorial, and give many hints to use libbpf instead of this out-of-date ELF-loader. This related to issue #34 Signed-off-by: Jesper Dangaard Brouer --- kernel/samples/bpf/README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 kernel/samples/bpf/README.rst diff --git a/kernel/samples/bpf/README.rst b/kernel/samples/bpf/README.rst new file mode 100644 index 0000000..2c5bab2 --- /dev/null +++ b/kernel/samples/bpf/README.rst @@ -0,0 +1,19 @@ +eBPF and XDP samples +==================== + +**UPDATE**: See `XDP-tutorial`_ if you want to learn eBPF-coding, +and not depend on kernel tree (instead it uses `libbpf`_). + +This directory is for prototyping BPF samples, that is intended for +inclusion in the Linux kernel tree containing `eBPF samples`_. If you don't +intend to send this at patches to the Linux kernel, then instead look at +`XDP-tutorial`_ for howto integrate with `libbpf`_. + +**WARNING**: This directory contains its own **out-of-date** BPF ELF-loader +(in `bpf_load.c`_). Instead people should use `libbpf`_. + + +.. _eBPF samples: https://github.com/torvalds/linux/blob/master/samples/bpf/ +.. _XDP-tutorial: https://github.com/xdp-project/xdp-tutorial +.. _bpf_load.c: bpf_load.c +.. _libbpf: https://github.com/libbpf/libbpf