[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] docs/sphinx/kerneldoc.py: Honour --enable-werror

From: Thomas Huth
Subject: Re: [PATCH] docs/sphinx/kerneldoc.py: Honour --enable-werror
Date: Thu, 16 Mar 2023 13:08:14 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.13.0

On 14/03/2023 12.44, Peter Maydell wrote:
Currently, the kerneldoc Sphinx plugin doesn't honour the
--enable-werror configure option, so its warnings are never fatal.
This is because although we do pass sphinx-build the -W switch, the
warnings from kerneldoc are produced by the scripts/kernel-doc script
directly and don't go through Sphinx's "emit a warning" function.

When --enable-werror is in effect, pass sphinx-build an extra
argument -Dkerneldoc_werror=1.  The kerneldoc plugin can then use
this to determine whether it should be passing the kernel-doc script

We do this because there is no documented mechanism for
a Sphinx plugin to determine whether sphinx-build was
passed -W or not; if one is provided then we can switch to
that at a later date:

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
NB: we need to land the fix for the current outstanding
warning before this one can go in...
  docs/meson.build         | 2 +-
  docs/sphinx/kerneldoc.py | 5 +++++
  2 files changed, 6 insertions(+), 1 deletion(-)

Reviewed-by: Thomas Huth <thuth@redhat.com>

reply via email to

[Prev in Thread] Current Thread [Next in Thread]