selftests/bpf: Make docs tests fail more reliably
Subsystems (3)
PATCH v2 1/1 selftests/bpf: Make docs tests fail more reliably
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
---
v2: Pass --exit-status=1 to rst2man instead of --strict
Ignore *.tmp files from the build
--- tools/testing/selftests/bpf/.gitignore | 1 + tools/testing/selftests/bpf/Makefile.docs | 3 ++- tools/testing/selftests/bpf/test_doc_build.sh | 1 + 3 files changed, 4 insertions(+), 1 deletion(-)
tools/testing/selftests/bpf/.gitignore +1 -0
@@ -37,5 +37,6 @@ test_cpp /runqslower /bench *.ko +*.tmp xdpxceiver xdp_redirect_multi
tools/testing/selftests/bpf/Makefile.docs +2 -1
@@ -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 --exit-status=1 $$< > [email protected] + $$(QUIET_GEN)mv [email protected] $$@ docs-clean-$1: $$(call QUIET_CLEAN, eBPF_$1-manpage)
tools/testing/selftests/bpf/test_doc_build.sh +1 -0
@@ -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.
Signature · 1 line
2.27.0
2021-06-07 18:57 UTC-0700 ~ Joe Stringer <[email protected]>
Quoted 10 lines
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.
Quoted 3 lines
Tested via
./tools/testing/selftests/bpf/test_doc_build.shSigned-off-by Joe Stringer <[email protected]>
This patch was applied to bpf/bpf-next.git (refs/heads/master):
Hello:
This patch was applied to bpf/bpf-next.git (refs/heads/master):
Quoted 11 lines · On Mon, 7 Jun 2021 18:57:56 -0700 you 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.
[...]
Here is the summary with links:
- [PATCHv2,bpf-next] selftests/bpf: Make docs tests fail more reliably
https://git.kernel.org/bpf/bpf-next/c/380afe720896
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html