From 2a8b4f2a79e020411503a85431550219accddc5d Mon Sep 17 00:00:00 2001 From: Michal Nowak Date: Wed, 3 Feb 2021 13:44:55 +0100 Subject: [PATCH 1/2] Build man pages when "make doc" is run Man pages are currently only generated from reStructuredText sources when "make man" is run in the doc/man/ directory. Tweak doc/man/Makefile.am so that running "make doc" in the top-level directory also causes man pages to be generated, so that all potential documentation building problems can be detected by a single make invocation. --- doc/man/Makefile.am | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index d363e35355..a62ca2c4cc 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -147,6 +147,8 @@ man_SUBST = \ .NOTPARALLEL: man man: Makefile $(man_MANS) +doc-local: man + clean-local:: -rm -rf $(SPHINXBUILDDIR) From 22fdcb30db28c7f8f007640096459b3900473ad1 Mon Sep 17 00:00:00 2001 From: Michal Nowak Date: Mon, 7 Dec 2020 18:08:53 +0100 Subject: [PATCH 2/2] Lint manual pages As we generate manual pages from reStructuredText sources, we don't have absolute control on manual page output and therefore 'mandoc -Tlint' may always report warnings we can't eliminate. In light of this some mandoc warnings need to be ignored. --- .gitlab-ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 03d6ae6cb4..d19b25a048 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -545,6 +545,7 @@ docs: - *configure - make -j${BUILD_PARALLEL_JOBS:-1} -k doc V=1 - qpdf --check doc/arm/_build/latex/Bv9ARM.pdf + - find doc/man/ -maxdepth 1 -name "*.[0-9]" -exec mandoc -T lint "{}" \; | ( ! grep -v -e "skipping paragraph macro. sp after" -e "unknown font, skipping request. ft C" ) needs: - job: autoreconf artifacts: true