From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S1752077AbcFDLlN (ORCPT <rfc822;w@1wt.eu>);
	Sat, 4 Jun 2016 07:41:13 -0400
Received: from mga11.intel.com ([192.55.52.93]:6711 "EHLO mga11.intel.com"
	rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
	id S1752010AbcFDLlJ (ORCPT <rfc822;linux-kernel@vger.kernel.org>);
	Sat, 4 Jun 2016 07:41:09 -0400
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.26,417,1459839600"; 
   d="scan'208";a="995120187"
From: Jani Nikula <jani.nikula@intel.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Jani Nikula <jani.nikula@intel.com>,
        Markus Heiser <markus.heiser@darmarit.de>,
        Daniel Vetter <daniel.vetter@ffwll.ch>,
        Grant Likely <grant.likely@secretlab.ca>,
        Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
        Keith Packard <keithp@keithp.com>, LKML <linux-kernel@vger.kernel.org>,
        linux-doc@vger.kernel.org, Hans Verkuil <hverkuil@xs4all.nl>
Subject: [PATCH v2 34/38] scripts/kernel-doc: Remove duplicated DOC: start handling
Date: Sat,  4 Jun 2016 14:37:35 +0300
Message-Id: <ebff7f929b2a72fa614f5e95fd34c56c82ac9c36.1465031816.git.jani.nikula@intel.com>
X-Mailer: git-send-email 2.1.4
In-Reply-To: <cover.1465031816.git.jani.nikula@intel.com>
References: <cover.1465031816.git.jani.nikula@intel.com>
In-Reply-To: <cover.1465031816.git.jani.nikula@intel.com>
References: <cover.1465031816.git.jani.nikula@intel.com>
Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

From: Daniel Vetter <daniel.vetter@ffwll.ch>

Further up in the state machinery we switch from STATE_NAME to
STATE_DOCBLOCK when we match /$doc_block/. Which means this block of
code here is entirely unreachable, unless there are multiple DOC:
sections within a single kernel-doc comment.

Getting a list of all the files with more than one DOC: section using

$ git grep -c " * DOC:" | grep -v ":1$"

and then doing a full audit of them reveals there are no such comment
blocks in the kernel.

Supporting multiple DOC: sections in a single kernel-doc comment does
not seem like a recommended way of doing things anyway, so nuke the code
for simplicity.

Cc: Jani Nikula <jani.nikula@intel.com>
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
[Jani: amended the commit message]
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 scripts/kernel-doc | 19 +------------------
 1 file changed, 1 insertion(+), 18 deletions(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 0eb2e7b5bf10..9fb26d142a56 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2942,24 +2942,7 @@ sub process_file($) {
 		process_state3_type($_, $file);
 	    }
 	} elsif ($state == STATE_DOCBLOCK) {
-		# Documentation block
-		if (/$doc_block/) {
-			dump_doc_section($file, $section, xml_escape($contents));
-			$contents = "";
-			$function = "";
-			%parameterdescs = ();
-			%parametertypes = ();
-			@parameterlist = ();
-			%sections = ();
-			@sectionlist = ();
-			$prototype = "";
-			if ( $1 eq "" ) {
-				$section = $section_intro;
-			} else {
-				$section = $1;
-			}
-		}
-		elsif (/$doc_end/)
+		if (/$doc_end/)
 		{
 			dump_doc_section($file, $section, xml_escape($contents));
 			$section = $section_default;
-- 
2.1.4