mbox series

[bpf-next,v2,0/4] bpf: clean up bpftool, bpftool doc, bpf-helpers doc

Message ID 20200511161536.29853-1-quentin@isovalent.com
Headers show
Series bpf: clean up bpftool, bpftool doc, bpf-helpers doc | expand

Message

Quentin Monnet May 11, 2020, 4:15 p.m. UTC 
This set focuses on cleaning-up the documentation for bpftool and BPF
helpers.

The first patch is actually a clean-up for bpftool itself: it replaces
kernel integer types by the ones that should be used in user space, and
poisons kernel types to avoid reintroducing them by mistake in the future.

Then come the documentation fixes: bpftool, and BPF helpers, with the usual
sync up for the BPF header under tools/. Please refer to individual commit
logs for details.

Quentin Monnet (4):
  tools: bpftool: poison and replace kernel integer typedefs
  tools: bpftool: minor fixes for documentation
  bpf: minor fixes to BPF helpers documentation
  tools: bpf: synchronise BPF UAPI header with tools

 include/uapi/linux/bpf.h                      | 109 ++++++++++--------
 scripts/bpf_helpers_doc.py                    |   6 +
 .../bpf/bpftool/Documentation/bpftool-btf.rst |  11 +-
 .../bpftool/Documentation/bpftool-cgroup.rst  |  12 +-
 .../bpftool/Documentation/bpftool-feature.rst |  12 +-
 .../bpf/bpftool/Documentation/bpftool-gen.rst |  21 ++--
 .../bpftool/Documentation/bpftool-iter.rst    |  12 +-
 .../bpftool/Documentation/bpftool-link.rst    |   9 +-
 .../bpf/bpftool/Documentation/bpftool-map.rst |  37 +++---
 .../bpf/bpftool/Documentation/bpftool-net.rst |  12 +-
 .../bpftool/Documentation/bpftool-perf.rst    |  12 +-
 .../bpftool/Documentation/bpftool-prog.rst    |  23 ++--
 .../Documentation/bpftool-struct_ops.rst      |  11 +-
 tools/bpf/bpftool/Documentation/bpftool.rst   |  11 +-
 tools/bpf/bpftool/btf_dumper.c                |   4 +-
 tools/bpf/bpftool/cfg.c                       |   4 +-
 tools/bpf/bpftool/main.h                      |   3 +
 tools/bpf/bpftool/map.c                       |   3 +-
 tools/bpf/bpftool/map_perf_ring.c             |   2 +-
 tools/bpf/bpftool/prog.c                      |   2 +-
 tools/include/uapi/linux/bpf.h                | 109 ++++++++++--------
 21 files changed, 249 insertions(+), 176 deletions(-)

Comments

Daniel Borkmann May 11, 2020, 8:34 p.m. UTC | #1 
On 5/11/20 6:15 PM, Quentin Monnet wrote:
> This set focuses on cleaning-up the documentation for bpftool and BPF
> helpers.
> 
> The first patch is actually a clean-up for bpftool itself: it replaces
> kernel integer types by the ones that should be used in user space, and
> poisons kernel types to avoid reintroducing them by mistake in the future.
> 
> Then come the documentation fixes: bpftool, and BPF helpers, with the usual
> sync up for the BPF header under tools/. Please refer to individual commit
> logs for details.
> 
> Quentin Monnet (4):
>    tools: bpftool: poison and replace kernel integer typedefs
>    tools: bpftool: minor fixes for documentation
>    bpf: minor fixes to BPF helpers documentation
>    tools: bpf: synchronise BPF UAPI header with tools

Applied, thanks!