[PATCH 3/3] build: add doccheck target to run the Sphinx HTML build with strict options

Jani Nikula jani.nikula at intel.com
Thu Apr 26 15:10:52 UTC 2018


-E to ignore cached files, -n to run in nit-picky mode, -W to turn
 warnings into errors, and -q for quiet.

Document the existing check targets in make help while at it.

Signed-off-by: Jani Nikula <jani.nikula at intel.com>
---
 Makefile | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index df250fe2c943..b23ed0bd84e8 100644
--- a/Makefile
+++ b/Makefile
@@ -57,7 +57,7 @@ mancheck:
 	rst2man --strict --no-raw dim.rst >/dev/null
 	rst2man --strict --no-raw qf.rst >/dev/null
 
-check: shellcheck mancheck
+check: shellcheck mancheck doccheck
 
 .PHONY: clean
 clean:
@@ -71,10 +71,14 @@ help:
 	@echo "  singlehtml to make a single large HTML file"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  doccheck   to check standalone HTML build"
+	@echo "  mancheck   to check man pages using rst2html"
+	@echo "  shellcheck to check shell scripts using shellcheck"
+	@echo "  check      to run all *check targets"
 
 # FIXME: This works for the first build, but not for updates. Look into using
 # Sphinx extensions for both the graphviz and wavedrom parts.
-html dirhtml singlehtml linkcheck doctest: drm-intel-flow.svg drm-misc-commit-flow.svg
+html dirhtml singlehtml linkcheck doctest doccheck: drm-intel-flow.svg drm-misc-commit-flow.svg
 
 .PHONY: html
 html:
@@ -106,3 +110,7 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: doccheck
+doccheck:
+	$(SPHINXBUILD) -EWnq -b html $(ALLSPHINXOPTS) $(BUILDDIR)/doccheck
-- 
2.11.0



More information about the dim-tools mailing list