mbox series

[bpf-next,0/3] bpftool: update documentation and fix checks

Message ID 20211115225844.33943-1-quentin@isovalent.com (mailing list archive)
Headers show
Series bpftool: update documentation and fix checks | expand

Message

Quentin Monnet Nov. 15, 2021, 10:58 p.m. UTC 
This set updates the list of options for bpftool commands, as displayed in
the summary of the man pages. It also updates the script that checks those
option lists, to make it more robust, and more reusable if the layout of
bpftool's directory changed.

Checkpatch complained about the missing SPDX tag when I added a new file
under bpftool/Documentation; I fixed it by adding the tag, and while at it,
I also added the tags to all RST files for bpftool's documentation (see
first patch of this set).

Quentin Monnet (3):
  bpftool: Add SPDX tags to RST documentation files
  bpftool: Update doc (use susbtitutions) and test_bpftool_synctypes.py
  selftests/bpf: Configure dir paths via env in
    test_bpftool_synctypes.py

 tools/bpf/bpftool/Documentation/Makefile      |  2 +-
 .../bpf/bpftool/Documentation/bpftool-btf.rst |  7 +-
 .../bpftool/Documentation/bpftool-cgroup.rst  |  7 +-
 .../bpftool/Documentation/bpftool-feature.rst |  6 +-
 .../bpf/bpftool/Documentation/bpftool-gen.rst |  7 +-
 .../bpftool/Documentation/bpftool-iter.rst    |  6 +-
 .../bpftool/Documentation/bpftool-link.rst    |  7 +-
 .../bpf/bpftool/Documentation/bpftool-map.rst |  7 +-
 .../bpf/bpftool/Documentation/bpftool-net.rst |  6 +-
 .../bpftool/Documentation/bpftool-perf.rst    |  6 +-
 .../bpftool/Documentation/bpftool-prog.rst    |  6 +-
 .../Documentation/bpftool-struct_ops.rst      |  6 +-
 tools/bpf/bpftool/Documentation/bpftool.rst   |  7 +-
 .../bpftool/Documentation/common_options.rst  |  2 +
 .../bpftool/Documentation/substitutions.rst   |  3 +
 .../selftests/bpf/test_bpftool_synctypes.py   | 94 ++++++++++++++++---
 16 files changed, 145 insertions(+), 34 deletions(-)
 create mode 100644 tools/bpf/bpftool/Documentation/substitutions.rst

Comments

patchwork-bot+netdevbpf@kernel.org Nov. 16, 2021, 1 p.m. UTC | #1 
Hello:

This series was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <daniel@iogearbox.net>:

On Mon, 15 Nov 2021 22:58:41 +0000 you wrote:
> This set updates the list of options for bpftool commands, as displayed in
> the summary of the man pages. It also updates the script that checks those
> option lists, to make it more robust, and more reusable if the layout of
> bpftool's directory changed.
> 
> Checkpatch complained about the missing SPDX tag when I added a new file
> under bpftool/Documentation; I fixed it by adding the tag, and while at it,
> I also added the tags to all RST files for bpftool's documentation (see
> first patch of this set).
> 
> [...]

Here is the summary with links:
  - [bpf-next,1/3] bpftool: Add SPDX tags to RST documentation files
    https://git.kernel.org/bpf/bpf-next/c/4344842836e9
  - [bpf-next,2/3] bpftool: Update doc (use susbtitutions) and test_bpftool_synctypes.py
    https://git.kernel.org/bpf/bpf-next/c/b62318152040
  - [bpf-next,3/3] selftests/bpf: Configure dir paths via env in test_bpftool_synctypes.py
    https://git.kernel.org/bpf/bpf-next/c/e12cd158c8a4

You are awesome, thank you!