Skip to content

bpf: detect build errors for man pages for bpftool and eBPF helpers

Quentin Monnet bpf netdev 2 versions – Applied

Status from this message: Applied. Thanks

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest2 patches 4 repliesApplied
  2. v12 patches 2 repliesSuperseded

Changes in v2 from the cover letter

- Pass rst2man option through a dedicated variable, use it to ask for a non-zero exit value on errors.
- Also build doc right after bpftool when building (not only running) the selftests.

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/2tools: bpftool: log info-level messages when building bpftool man pagestools/bpf/bpftool/Documentation/Makefile tools/bpf/bpftool/Documentation/bpftool-btf.rst tools/bpf/bpftool/Documentation/bpftool-gen.rst +1 more+12 -10 replies
2/2selftests, bpftool: add bpftool (and eBPF helpers) documentation buildtools/testing/selftests/bpf/Makefile tools/testing/selftests/bpf/test_bpftool_build.sh+26 -03 replies

Reviews trailers per patch

All 2 patches have a Reviewed-by or Acked-by.

PatchAndrii Nakryiko
1/2A-b
2/2A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [PATCH bpf-next v2 0/2] bpf: detect build errors for man pages for bpftool and eBPF helpers

This set aims at improving the checks for building bpftool's documentation (including the man page for eBPF helper functions). The first patch lowers the log-level from rst2man and fix the reported informational messages. The second one extends the script used to build bpftool in the eBPF selftests, so that we also check a documentation build.

This is after a suggestion from Andrii Nakryiko.

v2:
- Pass rst2man option through a dedicated variable, use it to ask for a non-zero exit value on errors.
- Also build doc right after bpftool when building (not only running) the selftests.

Quentin Monnet (2):
tools: bpftool: log info-level messages when building bpftool man
pages
selftests, bpftool: add bpftool (and eBPF helpers) documentation build

 tools/bpf/bpftool/Documentation/Makefile      |  3 ++-
 .../bpf/bpftool/Documentation/bpftool-btf.rst |  3 +++
 .../bpf/bpftool/Documentation/bpftool-gen.rst |  4 ++++
 .../bpf/bpftool/Documentation/bpftool-map.rst |  3 +++
 tools/testing/selftests/bpf/Makefile          |  5 +++++
 .../selftests/bpf/test_bpftool_build.sh       | 21 +++++++++++++++++++
 6 files changed, 38 insertions(+), 1 deletion(-)
Signature · 1 line
2.25.1