| Message ID | 20200907164017.30644-1-quentin@isovalent.com |
|---|---|
| Headers | show |
| Series | bpf: detect build errors for man pages for bpftool and eBPF helpers | expand |
On Mon, Sep 7, 2020 at 9:40 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. > > 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@fb.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.
On 09/09/2020 04:48, Andrii Nakryiko wrote: > On Mon, Sep 7, 2020 at 9:40 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. >> >> 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@fb.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. > I see, indeed with this patch we would only build the doc on "make run_tests", not when building the selftests. I'll send another version that builds the doc at the same time as we build bpftool then. I also had another look at rst2man's options, and there's probably cleaner a way to get rid of the stderr redirection/line counting that I'm doing in this version. I'll fix that too. Thanks for the feedback. Quentin
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(-)