From 78e17a0db3a9d113a6957482245926373dc50f9b Mon Sep 17 00:00:00 2001 From: Robin Jarry Date: Sun, 17 Sep 2023 21:20:55 +0200 Subject: contrib: add script to check man pages consistency Add a new shell script to check that all commands are documented in man pages and that the man pages do not contain non-existent commands. Also check that all explicitly parsed options with ini reflection are documented as well. It is not possible to check if the man pages do reference non-existent options since some of the options are parsed lazily in workers and some of them are also declared with placeholders (e.g. *column-*). Run the script in the lint target. Signed-off-by: Robin Jarry Tested-by: Bence Ferdinandy --- GNUmakefile | 1 + 1 file changed, 1 insertion(+) (limited to 'GNUmakefile') diff --git a/GNUmakefile b/GNUmakefile index 7704fcdb..95556bcf 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -53,6 +53,7 @@ linters.so: contrib/linters.go lint: linters.so @contrib/check-whitespace `git ls-files ':!:filters/vectors'` && \ echo white space ok. + @contrib/check-docs && echo docs ok. @$(GO) run mvdan.cc/gofumpt@$(gofumpt_tag) -d . | grep ^ \ && echo The above files need to be formatted, please run make fmt && exit 1 \ || echo all files formatted. -- cgit