Re: [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build

[Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>]

27.04.2019 1:15, John Snow wrote:
> If we add references that don't resolve (or accidentally remove them),
> it will be helpful to have an error message alerting us to that.

the wording still a bit in conflict with the fact that -n is originally a warning, not error,
but I don't really care:

Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>

> 
> Turn warnings into errors so we can be alerted to problems in building
> the documentation when they arise.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   Makefile | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Makefile b/Makefile
> index 626a04d305..1211e78c91 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -926,7 +926,7 @@ docs/version.texi: $(SRC_PATH)/VERSION
>   sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html
>   
>   # Canned command to build a single manual
> -build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
> +build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
>   # We assume all RST files in the manual's directory are used in it
>   manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py
>   
> 


-- 
Best regards,
Vladimir