| Message ID | 20210608015756.340385-1-joe@cilium.io (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 380afe7208966ab59e5215c9daab3f6b06193d8c |
| Delegated to: | BPF |
| Headers | show |
| Series | [PATCHv2,bpf-next] selftests/bpf: Make docs tests fail more reliably | expand |
| Context | Check | Description |
|---|---|---|
| netdev/cover_letter | success | Link |
| netdev/fixes_present | success | Link |
| netdev/patch_count | success | Link |
| netdev/tree_selection | success | Clearly marked for bpf-next |
| netdev/subject_prefix | success | Link |
| netdev/cc_maintainers | warning | 9 maintainers not CCed: linux-kselftest@vger.kernel.org netdev@vger.kernel.org yhs@fb.com kpsingh@kernel.org andrii@kernel.org kafai@fb.com john.fastabend@gmail.com songliubraving@fb.com shuah@kernel.org |
| netdev/source_inline | success | Was 0 now: 0 |
| netdev/verify_signedoff | success | Link |
| netdev/module_param | success | Was 0 now: 0 |
| netdev/build_32bit | success | Errors and warnings before: 0 this patch: 0 |
| netdev/kdoc | success | Errors and warnings before: 0 this patch: 0 |
| netdev/verify_fixes | success | Link |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 21 lines checked |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 0 this patch: 0 |
| netdev/header_inline | success | Link |
2021-06-07 18:57 UTC-0700 ~ Joe Stringer <joe@cilium.io> > 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@cilium.io> Reviewed-by: Quentin Monnet <quentin@isovalent.com>
Hello: This patch was applied to bpf/bpf-next.git (refs/heads/master): 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
diff --git a/tools/testing/selftests/bpf/.gitignore b/tools/testing/selftests/bpf/.gitignore index a18f57044014..eae6fc7d3ed8 100644 --- a/tools/testing/selftests/bpf/.gitignore +++ b/tools/testing/selftests/bpf/.gitignore @@ -37,5 +37,6 @@ test_cpp /runqslower /bench *.ko +*.tmp xdpxceiver xdp_redirect_multi diff --git a/tools/testing/selftests/bpf/Makefile.docs b/tools/testing/selftests/bpf/Makefile.docs index ccf260021e83..eb6a4fea8c79 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 --exit-status=1 $$< > $$@.tmp + $$(QUIET_GEN)mv $$@.tmp $$@ 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.
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@cilium.io> --- 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(-)