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

[Vladimir Sementsov-Ogievskiy]

23.04.2019 21:06, John Snow wrote:
> 
> 
> On 4/23/19 2:03 PM, Vladimir Sementsov-Ogievskiy wrote:
>> 23.04.2019 1:17, 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.
>>
>> accordingly to docs I've found, not error but warning.
>>
> Oh, true. I have to revise the document anyway, so I'll change my
> phrasing here -- it won't cause the build to fail, but you will be able
> to see the error when you build. I think it's helpful to have as a
> mechanical check -- especially if we succeed in building generated ReST
> documentation (eventually?...)

Hm, if we now don't have other warnings, we may also enable -W, to be strict.

> 
>>>
>>> Signed-off-by: John Snow <address@hidden>
>>
>> Reviewed-by: Vladimir Sementsov-Ogievskiy <address@hidden>
>>
>>> ---
>>>    Makefile | 2 +-
>>>    1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/Makefile b/Makefile
>>> index 04a0d45050..ff9ce2ed4c 100644
>>> --- a/Makefile
>>> +++ b/Makefile
>>> @@ -899,7 +899,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) -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