kernel-doc checks were initially enabled only for builds which had extra
warnings enabled. We have now eliminated enough kernel-doc warnings that
we can enable kernel-doc checking by default. This comes at a slight
cost; for an allmodconfig build, make -j8 fs/ timings on my laptop
increase by less than 5%:
before real 4m7.456s 4m4.416s 4m6.663s
after real 4m18.960s 4m21.566s 4m23.234s
before user 29m35.370s 29m11.036s 29m30.092s
after user 30m55.602s 31m10.918s 31m20.311s
before sys 2m8.230s 2m6.392s 2m9.727s
after sys 2m19.896 2m23.422s 2m25.762s
This feels like a reasonable price to pay to force people to keep
documentation up to date.
Signed-off-by: Matthew Wilcox (Oracle) <willy@xxxxxxxxxxxxx>
Reviewed-by: Carlos Bilbao <carlos.bilbao@xxxxxxx>
---
scripts/Makefile.build | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/scripts/Makefile.build b/scripts/Makefile.build
index 82e3fb19fdaf..52f57c0c5227 100644
--- a/scripts/Makefile.build
+++ b/scripts/Makefile.build
@@ -100,11 +100,9 @@ else ifeq ($(KBUILD_CHECKSRC),2)
cmd_force_checksrc = $(CHECK) $(CHECKFLAGS) $(c_flags) $<
endif
-ifneq ($(KBUILD_EXTRA_WARN),)
- cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $(KDOCFLAGS) \
+cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $(KDOCFLAGS) \
$(if $(findstring 2, $(KBUILD_EXTRA_WARN)), -Wall) \
$<
-endif
# Compile C sources (.c)
# ---------------------------------------------------------------------------
--
2.40.1
