From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932673Ab2K0Bnz (ORCPT ); Mon, 26 Nov 2012 20:43:55 -0500 Received: from casper.infradead.org ([85.118.1.10]:37298 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1757805Ab2K0Bny (ORCPT ); Mon, 26 Nov 2012 20:43:54 -0500 Message-ID: <50B41AC7.8030904@infradead.org> Date: Mon, 26 Nov 2012 17:43:35 -0800 From: Randy Dunlap User-Agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.2.15) Gecko/20110323 Thunderbird/3.1.9 MIME-Version: 1.0 To: Yacine Belkadi CC: Andrew Morton , Randy Dunlap , Daniel Santos , Michal Marek , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Rob Landley Subject: Re: [PATCHv2 2/2] scripts/kernel-doc: check that non-void fcts describe their return value References: <1353964883-3121-1-git-send-email-yacine.belkadi.1@gmail.com> <1353964947-3152-1-git-send-email-yacine.belkadi.1@gmail.com> In-Reply-To: <1353964947-3152-1-git-send-email-yacine.belkadi.1@gmail.com> Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 Both patches: Acked-by: Randy Dunlap Michal, please merge patches 1 and 2. Thanks. > --- > scripts/kernel-doc | 34 ++++++++++++++++++++++++++++++++++ > 1 file changed, 34 insertions(+) > > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 46e7aff..28b7615 100755 > --- a/scripts/kernel-doc > +++ b/scripts/kernel-doc > @@ -137,6 +137,8 @@ use strict; > # should document the "Context:" of the function, e.g. whether the functions > # can be called form interrupts. Unlike other sections you can end it with an > # empty line. > +# A non-void function should have a "Return:" section describing the return > +# value(s). > # Example-sections should contain the string EXAMPLE so that they are marked > # appropriately in DocBook. > # > @@ -315,6 +317,7 @@ my $section_default = "Description"; # default section > my $section_intro = "Introduction"; > my $section = $section_default; > my $section_context = "Context"; > +my $section_return = "Return"; > > my $undescribed = "-- undescribed --"; > > @@ -2039,6 +2042,28 @@ sub check_sections($$$$$$) { > } > > ## > +# Checks the section describing the return value of a function. > +sub check_return_section { > + my $file = shift; > + my $declaration_name = shift; > + my $return_type = shift; > + > + # Ignore an empty return type (It's a macro) > + # Ignore functions with a "void" return type. (But don't ignore "void *") > + if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { > + return; > + } > + > + if (!defined($sections{$section_return}) || > + $sections{$section_return} eq "") { > + print STDERR "Warning(${file}:$.): " . > + "No description found for return value of " . > + "'$declaration_name'\n"; > + ++$warnings; > + } > +} > + > +## > # takes a function prototype and the name of the current file being > # processed and spits out all the details stored in the global > # arrays/hashes. > @@ -2109,6 +2134,15 @@ sub dump_function($$) { > my $prms = join " ", @parameterlist; > check_sections($file, $declaration_name, "function", $sectcheck, $prms, ""); > > + # 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. > + # TODO: always perform the check. > + if ($verbose) { > + check_return_section($file, $declaration_name, $return_type); > + } > + > output_declaration($declaration_name, > 'function', > {'function' => $declaration_name, -- ~Randy