mbox series

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

Message ID 20200909162251.15498-1-quentin@isovalent.com
Headers show
Series bpf: detect build errors for man pages for bpftool and eBPF helpers | expand

Message

Quentin Monnet Sept. 9, 2020, 4:22 p.m. UTC
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(-)

Comments

Alexei Starovoitov Sept. 10, 2020, 6:12 p.m. UTC | #1
On Wed, Sep 9, 2020 at 9:22 AM Quentin Monnet <quentin@isovalent.com> wrote:
>
> 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.

Applied. Thanks