[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH for-5.0? 1/3] configure: Honour --disable-werror for Sphinx
From: |
Alex Bennée |
Subject: |
Re: [PATCH for-5.0? 1/3] configure: Honour --disable-werror for Sphinx |
Date: |
Tue, 14 Apr 2020 15:48:08 +0100 |
User-agent: |
mu4e 1.3.10; emacs 28.0.50 |
Peter Maydell <address@hidden> writes:
> If we are not making warnings fatal for compilation, make them
> non-fatal when building the Sphinx documentation also. (For instance
> Sphinx 3.0 warns about some constructs that older versions were happy
> with, which is a build failure if we use the warnings-as-errors
> flag.)
>
> This provides a workaround at least for LP:1872113.
>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
> configure | 9 ++++++++-
> Makefile | 2 +-
> 2 files changed, 9 insertions(+), 2 deletions(-)
>
> diff --git a/configure b/configure
> index 22870f38672..7b9ae0418d0 100755
> --- a/configure
> +++ b/configure
> @@ -4928,6 +4928,12 @@ if check_include sys/kcov.h ; then
> kcov=yes
> fi
>
> +# If we're making warnings fatal, apply this to Sphinx runs as well
> +sphinx_werror=""
> +if test "$werror" = "yes"; then
> + sphinx_werror="-W"
> +fi
> +
I wonder if this would have caught the failure I was seeing on debian9 +
mxe images?
> # Check we have a new enough version of sphinx-build
> has_sphinx_build() {
> # This is a bit awkward but works: create a trivial document and
> @@ -4936,7 +4942,7 @@ has_sphinx_build() {
> # sphinx-build doesn't exist at all or if it is too old.
> mkdir -p "$TMPDIR1/sphinx"
> touch "$TMPDIR1/sphinx/index.rst"
> - "$sphinx_build" -c "$source_path/docs" -b html "$TMPDIR1/sphinx"
> "$TMPDIR1/sphinx/out" >/dev/null 2>&1
> + "$sphinx_build" $sphinx_werror -c "$source_path/docs" -b html
> "$TMPDIR1/sphinx" "$TMPDIR1/sphinx/out" >/dev/null 2>&1
Note this will clash with the simple configure change I made to redirect
the output to config.log.
Anyway:
Reviewed-by: Alex Bennée <address@hidden>
--
Alex Bennée
- [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3, Peter Maydell, 2020/04/11
- [PATCH for-5.0? 2/3] scripts/kernel-doc: Add missing close-paren in c:function directives, Peter Maydell, 2020/04/11
- [PATCH for-5.0? 1/3] configure: Honour --disable-werror for Sphinx, Peter Maydell, 2020/04/11
- [PATCH for-5.0? 3/3] kernel-doc: Use c:struct for Sphinx 3.0 and later, Peter Maydell, 2020/04/11
- Re: [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3, Paolo Bonzini, 2020/04/13
- Supported Sphinx Versions (was: Re: [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3), John Snow, 2020/04/13