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

[Jani Nikula]

On Thu, 26 Apr 2018, Daniel Vetter <daniel at ffwll.ch> wrote:
> On Thu, Apr 26, 2018 at 06:10:52PM +0300, Jani Nikula wrote:
>> -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
>
> Very much in favour of always checking the sphinx build and throwing the
> old html build out (it just blew up in my face when I tried to sprinkle
> more links for the other patch I just sent out).
>
> On the series: Acked-by: Daniel Vetter <daniel.vetter at ffwll.ch>

Thanks, pushed.

BR,
Jani.

>>  
>>  .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
>> 
>> _______________________________________________
>> dim-tools mailing list
>> dim-tools at lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/dim-tools

-- 
Jani Nikula, Intel Open Source Technology Center