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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 8 Sep 2020 20:48:58 -0700
From:   Andrii Nakryiko <andrii.nakryiko@...il.com>
To:     Quentin Monnet <quentin@...valent.com>
Cc:     Alexei Starovoitov <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        bpf <bpf@...r.kernel.org>, Networking <netdev@...r.kernel.org>
Subject: Re: [PATCH bpf-next 0/2] bpf: detect build errors for man pages for
 bpftool and eBPF helpers

On Mon, Sep 7, 2020 at 9:40 AM Quentin Monnet <quentin@...valent.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.
>
> 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      |  2 +-
>  .../bpf/bpftool/Documentation/bpftool-btf.rst |  3 +++
>  .../bpf/bpftool/Documentation/bpftool-gen.rst |  4 ++++
>  .../bpf/bpftool/Documentation/bpftool-map.rst |  3 +++
>  .../selftests/bpf/test_bpftool_build.sh       | 23 +++++++++++++++++++
>  5 files changed, 34 insertions(+), 1 deletion(-)
>
> --
> 2.25.1
>

LGTM.

Acked-by: Andrii Nakryiko <andriin@...com>

But this still won't be run every time someone makes selftests. We do
build bpftool during selftests build, so it would be good to run doc
build there as well to ensure everyone is executing this. But this is
a good first step for sure.