[PATCH 1/2] doc/Makefile: turn warnings into errors

[Heinrich Schuchardt]

On 2/21/20 5:31 AM, Heinrich Schuchardt wrote:
> On 2/21/20 5:06 AM, Tom Rini wrote:
>> On Fri, Feb 21, 2020 at 04:26:36AM +0100, Heinrich Schuchardt wrote:
>>
>>> Several patches delivered incorrect restructured text as
>>> documentation. We
>>> should be able to discover this in Travis CI or Gitlab CI.
>>>
>>> So let us turn all build warnings into errors.
>>>
>>> We cannot add --keep-going as Gitlab does not use sphinx-build
>>> version 1.8
>>> or later yet.
>>
>> Why can't we upgrade sphinx-build so that we then run these builds also
>> in Gitlab / Azure?  Thanks!

Maybe this was unclear to you: My choice was not to use --keep-going
because I want run the test in the current Gitlab Docker image. With the
patch as it is we can run on Gitlab.

But there is another package (imagemagick) missing in the Dockerimage. I
am currently testing if this is the only missing package. I will submit
the .gitlab-ci.yml patch thereafter.

>
> This is what --keep-going does:
>
> With -W option, keep going processing when getting warnings to the end
> of build, and sphinx-build exits with exit status 1.
>
> So for the purpose of checking if there is *any* error in the
> documentation this flag does not make a difference.
>
> If we put the --keep-going flag into our Makefile, we require everybody
> in the U-Boot community to upgrade his Sphinx installation if he wants
> to run 'make htmldocs'. Is this what we want?
>
> Our Dockerfile is based on ubuntu:bionic-20200112. You could move to
> ubuntu:eoan-20200114 to get Sphinx 1.8.5.
>
> Best regards
>
> Heinrich