diff options
| author | Andrey Ignatov <rdna@fb.com> | 2020-03-24 11:51:35 -0700 |
|---|---|---|
| committer | Daniel Borkmann <daniel@iogearbox.net> | 2020-03-26 00:08:36 +0100 |
| commit | 8c061865f5ff66adca8056327accff1bf7d09d35 (patch) | |
| tree | 98dd009da525f7a23813f996b77e93b4c79ea9be /Documentation/bpf/index.rst | |
| parent | aa5e2af660fc6e35b9518d68dd7e1bb736e9f7e7 (diff) | |
bpf: Document bpf_inspect drgn tool
It's a follow-up for discussion in [1].
drgn tool bpf_inspect.py was merged to drgn repo in [2]. Document it
in kernel tree to make BPF developers aware that the tool exists and
can help with getting BPF state unavailable via UAPI.
For now it's just one tool but the doc is written in a way that allows
to cover more tools in the future if needed.
Please refer to the doc itself for more details.
The patch was tested by `make htmldocs` and sanity-checking that
resulting html looks good.
v2 -> v3:
- two sections: "Description" and "Getting started" (Daniel);
- add examples in "Getting started" section (Daniel);
- add "Customization" section to show how tool can be customized.
v1 -> v2:
- better "BPF drgn tools" section (Alexei)
[1] https://lore.kernel.org/bpf/20200228201514.GB51456@rdna-mbp/T/#mefed65e8a98116bd5d07d09a570a3eac46724951
[2] https://github.com/osandov/drgn/pull/49
Signed-off-by: Andrey Ignatov <rdna@fb.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200324185135.1431038-1-rdna@fb.com
Diffstat (limited to 'Documentation/bpf/index.rst')
| -rw-r--r-- | Documentation/bpf/index.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst index 4f5410b61441..7be43c5f2dcf 100644 --- a/Documentation/bpf/index.rst +++ b/Documentation/bpf/index.rst @@ -47,12 +47,13 @@ Program types prog_flow_dissector -Testing BPF -=========== +Testing and debugging BPF +========================= .. toctree:: :maxdepth: 1 + drgn s390 |