On Sat, Apr 10, 2021 at 10:57 AM Joe Stringer <joe@xxxxxxxxx> wrote: > > Previously, if rst2man caught errors, then these would be ignored and > the output file would be written anyway. This would allow developers to > introduce regressions in the docs comments in the BPF headers. > > Additionally, even if you instruct rst2man to fail out, it will still > write out to the destination target file, so if you ran the tests twice > in a row it would always pass. Use a temporary file for the initial run > to ensure that if rst2man fails out under "--strict" mode, subsequent > runs will not automatically pass. > > Tested via ./tools/testing/selftests/bpf/test_doc_build.sh > > Signed-off-by: Joe Stringer <joe@xxxxxxxxx> > --- > tools/testing/selftests/bpf/Makefile.docs | 3 ++- > tools/testing/selftests/bpf/test_doc_build.sh | 1 + > 2 files changed, 3 insertions(+), 1 deletion(-) > > diff --git a/tools/testing/selftests/bpf/Makefile.docs b/tools/testing/selftests/bpf/Makefile.docs > index ccf260021e83..a918790c8f9c 100644 > --- a/tools/testing/selftests/bpf/Makefile.docs > +++ b/tools/testing/selftests/bpf/Makefile.docs > @@ -52,7 +52,8 @@ $(OUTPUT)%.$2: $(OUTPUT)%.rst > ifndef RST2MAN_DEP > $$(error "rst2man not found, but required to generate man pages") > endif > - $$(QUIET_GEN)rst2man $$< > $$@ > + $$(QUIET_GEN)rst2man --strict $$< > $$@.tmp > + $$(QUIET_GEN)mv $$@.tmp $$@ if something goes wrong this .tmp file will be laying around, so we should at least add it to .gitignore? > > docs-clean-$1: > $$(call QUIET_CLEAN, eBPF_$1-manpage) > diff --git a/tools/testing/selftests/bpf/test_doc_build.sh b/tools/testing/selftests/bpf/test_doc_build.sh > index 7eb940a7b2eb..ed12111cd2f0 100755 > --- a/tools/testing/selftests/bpf/test_doc_build.sh > +++ b/tools/testing/selftests/bpf/test_doc_build.sh > @@ -1,5 +1,6 @@ > #!/bin/bash > # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +set -e > > # Assume script is located under tools/testing/selftests/bpf/. We want to start > # build attempts from the top of kernel repository. > -- > 2.27.0 >
