diff options
| author | Robin Jarry <robin@jarry.cc> | 2023-09-17 21:20:55 +0200 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2023-09-19 22:57:32 +0200 |
| commit | 78e17a0db3a9d113a6957482245926373dc50f9b (patch) | |
| tree | 513a4ce6e65511303d47ddb972a06893f9edd991 /GNUmakefile | |
| parent | de0b75d191f4f789d3870dae00871244d20aaf10 (diff) | |
| download | aerc-78e17a0db3a9d113a6957482245926373dc50f9b.tar.gz aerc-78e17a0db3a9d113a6957482245926373dc50f9b.zip | |
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-<name>*).
Run the script in the lint target.
Signed-off-by: Robin Jarry <robin@jarry.cc>
Tested-by: Bence Ferdinandy <bence@ferdinandy.com>
Diffstat (limited to 'GNUmakefile')
| -rw-r--r-- | GNUmakefile | 1 |
1 files changed, 1 insertions, 0 deletions
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. |