From 5ae2a2621ca8cf38a853729cef1f0fd86b6d936b Mon Sep 17 00:00:00 2001 From: Andrii Nakryiko <andrii@kernel.org> Date: Sun, 29 Nov 2020 13:34:03 -0800 Subject: [PATCH] readme: move gory sync details down and add libbpf-bootstrap references Move gory details about libbpf mirror and sync into a separate section at the bottom of README. Also add references to libbpf-bootstrap and blog about it, as well as libbpf-tools reference. --- README.md | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7af375f..1273a60 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ -This is a mirror of [bpf-next Linux source -tree](https://kernel.googlesource.com/pub/scm/linux/kernel/git/bpf/bpf-next)'s -`tools/lib/bpf` directory plus its supporting header files. +BPF/libbpf usage and questions +============================== -All the gory details of syncing can be found in `scripts/sync-kernel.sh` -script. - -Some header files in this repo (`include/linux/*.h`) are reduced versions of -their counterpart files at -[bpf-next](https://git.kernel.org/pub/scm/linux/kernel/git/bpf/bpf-next.git/)'s -`tools/include/linux/*.h` to make compilation successful. - -BPF questions -============= +Please check out [libbpf-bootstrap](https://github.com/libbpf/libbpf-bootstrap) +and [the companion blog post](https://nakryiko.com/posts/libbpf-bootstrap/) for +the examples of building BPF applications with libbpf. +[libbpf-tools](https://github.com/iovisor/bcc/tree/master/libbpf-tools) are also +a good source of the real-world libbpf-based tracing tools. All general BPF questions, including kernel functionality, libbpf APIs and their application, should be sent to bpf@vger.kernel.org mailing list. You can @@ -135,6 +129,20 @@ use it: contain lots of real-world tools converted from BCC to BPF CO-RE. Consider converting some more to both contribute to the BPF community and gain some more experience with it. + +Details +======= +This is a mirror of [bpf-next Linux source +tree](https://kernel.googlesource.com/pub/scm/linux/kernel/git/bpf/bpf-next)'s +`tools/lib/bpf` directory plus its supporting header files. + +All the gory details of syncing can be found in `scripts/sync-kernel.sh` +script. + +Some header files in this repo (`include/linux/*.h`) are reduced versions of +their counterpart files at +[bpf-next](https://git.kernel.org/pub/scm/linux/kernel/git/bpf/bpf-next.git/)'s +`tools/include/linux/*.h` to make compilation successful. License ======= -- GitLab