From: Michal Marek <mmarek@suse.cz>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Yacine Belkadi <yacine.belkadi.1@gmail.com>,
Andrew Morton <akpm@linux-foundation.org>,
Randy Dunlap <rdunlap@xenotime.net>,
Daniel Santos <daniel.santos@pobox.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Rob Landley <rob@landley.net>
Subject: Re: [PATCHv2 2/2] scripts/kernel-doc: check that non-void fcts describe their return value
Date: Thu, 06 Dec 2012 11:50:25 +0100 [thread overview]
Message-ID: <50C07871.5060404@suse.cz> (raw)
In-Reply-To: <50B41AC7.8030904@infradead.org>
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@gmail.com>
>
>
> Both patches:
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
>
> Michal, please merge patches 1 and 2.
Done.
Michal
prev parent reply other threads:[~2012-12-06 10:50 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-11-26 21:21 [PATCHv2 1/2] Kernel-doc: Convention: Use a "Return" section to describe return values Yacine Belkadi
2012-11-26 21:22 ` [PATCHv2 2/2] scripts/kernel-doc: check that non-void fcts describe their return value Yacine Belkadi
2012-11-27 1:43 ` Randy Dunlap
2012-11-27 10:39 ` Michal Marek
2012-11-27 20:27 ` [PATCHv2 1/2] Kernel-doc: Convention: Use a "Return" section to describe return values Yacine Belkadi
2012-11-27 20:27 ` [PATCHv2 2/2] scripts/kernel-doc: check that non-void fcts describe their return value Yacine Belkadi
2012-12-06 10:50 ` Michal Marek [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=50C07871.5060404@suse.cz \
--to=mmarek@suse.cz \
--cc=akpm@linux-foundation.org \
--cc=daniel.santos@pobox.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=rdunlap@xenotime.net \
--cc=rob@landley.net \
--cc=yacine.belkadi.1@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Powered by JetHome