lkml.org 
[lkml]   [2022]   [Jun]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH] scripts: kernel-doc: Always increment warnings counter
From


On 6/8/22 07:26, Niklas Söderlund wrote:
> Some warnings did not increment the warnings counter making the behavior
> of running kernel-doc with -Werror unlogical as some warnings would be
> generated but not treated as errors.
>
> Fix this by always incrementing the warnings counter every time a
> warning related to the input documentation is generated. There is one
> location in get_sphinx_version() where a warning is printed and the
> counter is not touched as it concerns the execution environment of the
> kernel-doc and not the documentation being processed.
>
> Incrementing the counter only have effect when running kernel-doc in
> either verbose mode (-v or environment variable KBUILD_VERBOSE) or when
> treating warnings as errors (-Werror or environment variable
> KDOC_WERROR). In both cases the number of warnings printed is printed to
> stderr and for the later the exit code of kernel-doc is non-zero if
> warnings where encountered.
>
> Simple test case to demo one of the warnings,
>
> $ cat test.c
> /**
> * foo() - Description
> */
> int bar();
>
> # Without this change
> $ ./scripts/kernel-doc -Werror -none test.c
> test.c:4: warning: expecting prototype for foo(). Prototype was for
> bar() instead
>
> # With this change
> $ ./scripts/kernel-doc -Werror -none test.c
> test.c:4: warning: expecting prototype for foo(). Prototype was for
> bar() instead
> 1 warnings as Errors
>
> Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> Signed-off-by: Simon Horman <simon.horman@corigine.com>
> Signed-off-by: Louis Peens <louis.peens@corigine.com>
> ---
> scripts/kernel-doc | 10 ++++++++++
> 1 file changed, 10 insertions(+)

LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

--
~Randy

\
 
 \ /
  Last update: 2022-06-08 16:46    [W:0.052 / U:0.016 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site