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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20180218164805.2cf46459@lwn.net>
Date:   Sun, 18 Feb 2018 16:48:05 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Markus Heiser <markus.heiser@...marit.de>
Cc:     Mike Rapoport <rppt@...ux.vnet.ibm.com>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] scripts: kernel_doc: fixup reporting of function
 identifiers

On Fri, 16 Feb 2018 17:36:07 +0100
Markus Heiser <markus.heiser@...marit.de> 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