Re: [PATCH] scripts: kernel_doc: fixup reporting of function identifiers

From: Jonathan Corbet
Date: Sun Feb 18 2018 - 18:48:33 EST


On Fri, 16 Feb 2018 17:36:07 +0100
Markus Heiser <markus.heiser@xxxxxxxxxxx> wrote:

> > So let me channel akpm here and ask: what are the user-visible effects of
> > this problem? I ask because applying it doesn't make any difference in
> > the "make htmldocs" output here. So I don't understand why you're
> > wanting to make this change.
>
> Use kernel-doc -v and take a look on the info-messages.
>
> In Documentation/doc-guide/kernel-doc we recommend to use
>
> /**
> * foo() - lorem ipsum
>
> to tag functions, but if you do so, the info message is broken,
> the function name is missed at the end of the message:
>
> ../test123.c:2: info: Scanning doc for

OK, so I guess that message is the only effect of this bug. Oh well,
I'll go ahead and apply the patch, thanks.

jon