[PATCH] doc: Makefile: turn warnings into errors by default

[PATCH] doc: Makefile: turn warnings into errors by default

[Quentin Schulz]

-W is for turning warnings into errors, --keep-going to make sure the
whole documentation is built and all warnings will be printed before
failing.

Since there's currently no warning, it's time to introduce it!

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Quentin Schulz <foss@0leil.net>
---
 doc/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/Makefile b/doc/Makefile
index d40f390e..996f01b7 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -j auto
+SPHINXOPTS    ?= -W --keep-going -j auto
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
-- 
2.31.1

Re: [docs] [PATCH] doc: Makefile: turn warnings into errors by default

[Michael Opdenacker]

Hello Quentin,

Thank you for the new *BitBake* documentation patch. I CC the
bitbake-devel mailing list.

On 7/26/21 5:34 PM, Quentin Schulz wrote:
> -W is for turning warnings into errors, --keep-going to make sure the
> whole documentation is built and all warnings will be printed before
> failing.
>
> Since there's currently no warning, it's time to introduce it!
>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> Signed-off-by: Quentin Schulz <foss@0leil.net>
> ---
>  doc/Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/Makefile b/doc/Makefile
> index d40f390e..996f01b7 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -3,7 +3,7 @@
>  
>  # You can set these variables from the command line, and also
>  # from the environment for the first two.
> -SPHINXOPTS    ?= -j auto
> +SPHINXOPTS    ?= -W --keep-going -j auto
>  SPHINXBUILD   ?= sphinx-build
>  SOURCEDIR     = .
>  BUILDDIR      = _build

Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

Richard, can you merge this patch as it was sent to the [docs] mailing list?
Thanks in advance,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] doc: Makefile: turn warnings into errors by default

[Richard Purdie]

On Mon, 2021-07-26 at 18:55 +0200, Michael Opdenacker wrote:
> Hello Quentin,
> 
> Thank you for the new *BitBake* documentation patch. I CC the
> bitbake-devel mailing list.
> 
> On 7/26/21 5:34 PM, Quentin Schulz wrote:
> > -W is for turning warnings into errors, --keep-going to make sure the
> > whole documentation is built and all warnings will be printed before
> > failing.
> > 
> > Since there's currently no warning, it's time to introduce it!
> > 
> > Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > 
> >  BUILDDIR      = _build
[...]

> 
> Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Richard, can you merge this patch as it was sent to the [docs] mailing list?
> Thanks in advance,

Merged, thanks.

Richard