mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v3 13/17] scripts: kernel-doc: get rid of $nested parameter
Date: Wed,  4 Oct 2017 08:48:51 -0300	[thread overview]
Message-ID: <55fca19c79979bb1392ed245cf19c8fa7696bfd4.1507116877.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1507116877.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1507116877.git.mchehab@s-opensource.com>

The check_sections() function has a $nested parameter, meant
to identify when a nested struct is present. As we now have
a logic that handles it, get rid of such parameter.

Suggested-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 scripts/kernel-doc | 19 ++++---------------
 1 file changed, 4 insertions(+), 15 deletions(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 1b4a096a409b..8fe62b2dbc2d 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -983,7 +983,6 @@ sub dump_union($$) {
 sub dump_struct($$) {
     my $x = shift;
     my $file = shift;
-    my $nested;
 
     if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
 	my $decl_type = $1;
@@ -1041,11 +1040,9 @@ sub dump_struct($$) {
 
 	# Ignore other nested elements, like enums
 	$members =~ s/({[^\{\}]*})//g;
-	$nested = $decl_type;
-	$nested =~ s/\/\*.*?\*\///gos;
 
 	create_parameterlist($members, ';', $file);
-	check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual, $nested);
+	check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
 
 	# Adjust declaration for better display
 	$declaration =~ s/([{;])/$1\n/g;
@@ -1350,8 +1347,8 @@ sub push_parameter($$$) {
 	$parametertypes{$param} = $type;
 }
 
-sub check_sections($$$$$$) {
-	my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
+sub check_sections($$$$$) {
+	my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
 	my @sects = split ' ', $sectcheck;
 	my @prms = split ' ', $prmscheck;
 	my $err;
@@ -1385,14 +1382,6 @@ sub check_sections($$$$$$) {
 					"'$sects[$sx]' " .
 					"description in '$decl_name'\n";
 				++$warnings;
-			} else {
-				if ($nested !~ m/\Q$sects[$sx]\E/) {
-				    print STDERR "${file}:$.: warning: " .
-					"Excess $decl_type member " .
-					"'$sects[$sx]' " .
-					"description in '$decl_name'\n";
-				    ++$warnings;
-				}
 			}
 		}
 	}
@@ -1503,7 +1492,7 @@ sub dump_function($$) {
     }
 
 	my $prms = join " ", @parameterlist;
-	check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
+	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
-- 
2.13.6

  parent reply	other threads:[~2017-10-04 11:58 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-04 11:48 [PATCH v3 00/17] kernel-doc: add supported to document nested structs/ Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 01/17] docs: kernel-doc.rst: better describe kernel-doc arguments Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 02/17] docs: kernel-doc.rst: improve private members description Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 03/17] docs: kernel-doc.rst: improve function documentation section Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 04/17] docs: kernel-doc.rst: improve structs chapter Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 05/17] docs: kernel-doc.rst: improve typedef documentation Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 06/17] docs: kernel-doc.rst: add documentation about man pages Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 07/17] docs: get rid of kernel-doc-nano-HOWTO.txt Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 08/17] scripts: kernel-doc: get rid of unused output formats Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 09/17] scripts: kernel-doc: improve argument handling Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 10/17] scripts: kernel-doc: change default to ReST format Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 11/17] scripts: kernel-doc: replace tabs by spaces Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 12/17] scripts: kernel-doc: parse next structs/unions Mauro Carvalho Chehab
2017-10-04 11:48 ` Mauro Carvalho Chehab [this message]
2017-10-04 11:48 ` [PATCH v3 14/17] scripts: kernel-doc: print the declaration name on warnings Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 15/17] scripts: kernel-doc: handle nested struct function arguments Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 16/17] scripts: kernel-doc: improve nested logic to handle multiple identifiers Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 17/17] w1_netlink.h: add support for nested structs Mauro Carvalho Chehab
2017-10-07 16:34 ` [PATCH v3 00/17] kernel-doc: add supported to document nested structs/ Jonathan Corbet
2017-10-08 10:07   ` Markus Heiser
2017-10-09 13:19     ` Mauro Carvalho Chehab
2017-10-11 19:17       ` Mauro Carvalho Chehab
2017-12-18 15:26 ` Mauro Carvalho Chehab

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=55fca19c79979bb1392ed245cf19c8fa7696bfd4.1507116877.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /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

all inboxes | Powered by JetHome®