linux-kernel - Re: [PATCHv2 2/2] scripts/kernel-doc: check that non-void fcts describe their return value

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: <50C07871.5060404@suse.cz>
Date:	Thu, 06 Dec 2012 11:50:25 +0100
From:	Michal Marek <mmarek@...e.cz>
To:	Randy Dunlap <rdunlap@...radead.org>
Cc:	Yacine Belkadi <yacine.belkadi.1@...il.com>,
	Andrew Morton <akpm@...ux-foundation.org>,
	Randy Dunlap <rdunlap@...otime.net>,
	Daniel Santos <daniel.santos@...ox.com>,
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
	Rob Landley <rob@...dley.net>
Subject: Re: [PATCHv2 2/2] scripts/kernel-doc: check that non-void fcts describe
 their return value

On 27.11.2012 02:43, Randy Dunlap wrote:
> On 11/26/2012 01:22 PM, Yacine Belkadi wrote:
> 
>> If a function has a return value, but its kernel-doc comment doesn't contain a
>> "Return" section, then emit the following warning:
>>
>>    Warning(file.h:129): No description found for return value of 'fct'
>>
>> Note: This check emits a lot of warnings at the moment, because many functions
>> don't have a 'Return' doc section. So until the number of warnings goes
>> sufficiently down, the check is only performed in verbose mode.
>>
>> Signed-off-by: Yacine Belkadi <yacine.belkadi.1@...il.com>
> 
> 
> Both patches:
> Acked-by: Randy Dunlap <rdunlap@...radead.org>
> 
> Michal, please merge patches 1 and 2.

Done.

Michal
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/