bpf: Document bpf_inspect drgn tool
authorAndrey Ignatov <rdna@fb.com>
Tue, 24 Mar 2020 18:51:35 +0000 (11:51 -0700)
committerDaniel Borkmann <daniel@iogearbox.net>
Wed, 25 Mar 2020 23:08:36 +0000 (00:08 +0100)
commit8c061865f5ff66adca8056327accff1bf7d09d35
tree98dd009da525f7a23813f996b77e93b4c79ea9be
parentaa5e2af660fc6e35b9518d68dd7e1bb736e9f7e7
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
Documentation/bpf/drgn.rst [new file with mode: 0644]
Documentation/bpf/index.rst