From patchwork Wed Feb 7 17:26:18 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 127194 Delivered-To: patch@linaro.org Received: by 10.46.124.24 with SMTP id x24csp683110ljc; Wed, 7 Feb 2018 09:27:09 -0800 (PST) X-Google-Smtp-Source: AH8x225xaJ5CIqpuOffemZNIPjklEwhv83Pg3ASQ7tUZtOpLPcP4vnCvxXEvWOPfy3clWIgI3tHq X-Received: by 2002:a17:902:4523:: with SMTP id m32-v6mr6752807pld.449.1518024429525; Wed, 07 Feb 2018 09:27:09 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1518024429; cv=none; d=google.com; s=arc-20160816; b=edYk4KCTfcBp3Le812+nMGCKlUvND9Uigq+WWQAbHJJgTEJeQ5hDRhIs8dtwiSGBdG fl9lsWVmZAHN/sjx6WqAdgDCySXNpxSk4BbLeZr+RG5N2auHRAxz0MVn8prD8Oae4T79 Bg2DSIKEzS2PSSWOk9jCAfKEB9siQijT9YanzWSFQsEChVJsVO3qrARqskQjkCuV3POY ooVh/Luraublyof7NhvVTPosz45mj1UP8VKy7TlmXmfX83qQ+HvpawLpRMNLoUTNC+VU PzfeFQC0AXRwJ78VKmp/iuEIIkUxSwKeNpd9itpOUQrzkJWFssYVkSW0k06WKvatarz1 5Pew== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:arc-authentication-results; bh=16tr8AtcAQ3CZwbCUg3wz03v6qIRwahoYMqZP/6RFKM=; b=bDkpnOIYYB7DDz9suMW+BqdOLeSmujx4+RK6rWDol5sijF9wOhg111gYSyN0BQrKEA EsUJYEYotNn75IMF51KM3BzNNbRQCa4xK7oRPL9e/953S1DX4yG7nH22+qJTBS1I8mY8 IVVI8tjOnFN4CMzT74wKkG1iKUNBU11vyaZT1UZOtt2WAiJDpAt+YAXe8AjWRCcCgCBx a6ZdLbNbGVaCoDp/lIzzMHduRbLdRUnA3Ktf841ZijXFhGy31fz9V+3v7QTfBtte+Qbq Md0qMGimwZ5wlc1esjtb4cgdJQ1tFVg5LPm5lC1M/wUAKVZBg1ukm2NJcv2Nutq3mAJY Kzaw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id t4si1194173pgr.205.2018.02.07.09.27.09; Wed, 07 Feb 2018 09:27:09 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754865AbeBGR1G (ORCPT + 18 others); Wed, 7 Feb 2018 12:27:06 -0500 Received: from ms.lwn.net ([45.79.88.28]:41626 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754466AbeBGR1B (ORCPT ); Wed, 7 Feb 2018 12:27:01 -0500 Received: from tpad.lan (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id A13BD491; Wed, 7 Feb 2018 17:27:00 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, mchehab@kernel.org, me@tobin.cc, Jonathan Corbet Subject: [PATCH 2/8] docs: kernel-doc: Rename and split STATE_FIELD Date: Wed, 7 Feb 2018 10:26:18 -0700 Message-Id: <20180207172624.24555-3-corbet@lwn.net> X-Mailer: git-send-email 2.14.3 In-Reply-To: <20180207172624.24555-1-corbet@lwn.net> References: <20180207172624.24555-1-corbet@lwn.net> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org STATE_FIELD describes a parser state that can handle any part of a kerneldoc comment body; rename it to STATE_BODY to reflect that. The $in_purpose variable was a hidden substate of STATE_FIELD; get rid of it and make a proper state (STATE_BODY_MAYBE) instead. This will make the subsequent process_file() splitup easier. Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) -- 2.14.3 Reviewed-by: Jani Nikula diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 5aa4ce211fc6..ad30c52f91ef 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -328,10 +328,11 @@ my $lineprefix=""; use constant { STATE_NORMAL => 0, # normal code STATE_NAME => 1, # looking for function name - STATE_FIELD => 2, # scanning field start - STATE_PROTO => 3, # scanning prototype - STATE_DOCBLOCK => 4, # documentation block - STATE_INLINE => 5, # gathering documentation outside main block + STATE_BODY_MAYBE => 2, # body - or maybe more description + STATE_BODY => 3, # the body of the comment + STATE_PROTO => 4, # scanning prototype + STATE_DOCBLOCK => 5, # documentation block + STATE_INLINE => 6, # gathering documentation outside main block }; my $state; my $in_doc_sect; @@ -1784,7 +1785,6 @@ sub process_file($) { my $identifier; my $func; my $descr; - my $in_purpose = 0; my $initial_section_counter = $section_counter; my ($orig_file) = @_; my $leading_space; @@ -1830,7 +1830,7 @@ sub process_file($) { $identifier = $1; } - $state = STATE_FIELD; + $state = STATE_BODY; # if there's no @param blocks need to set up default section # here $contents = ""; @@ -1843,7 +1843,7 @@ sub process_file($) { $descr =~ s/\s*$//; $descr =~ s/\s+/ /g; $declaration_purpose = $descr; - $in_purpose = 1; + $state = STATE_BODY_MAYBE; } else { $declaration_purpose = ""; } @@ -1875,7 +1875,7 @@ sub process_file($) { ++$warnings; $state = STATE_NORMAL; } - } elsif ($state == STATE_FIELD) { # look for head: lines, and include content + } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE) { if (/$doc_sect/i) { # case insensitive for supported section names $newsection = $1; $newcontents = $2; @@ -1902,7 +1902,7 @@ sub process_file($) { } $in_doc_sect = 1; - $in_purpose = 0; + $state = STATE_BODY; $contents = $newcontents; $new_start_line = $.; while (substr($contents, 0, 1) eq " ") { @@ -1941,8 +1941,8 @@ sub process_file($) { } else { $contents .= "\n"; } - $in_purpose = 0; - } elsif ($in_purpose == 1) { + $state = STATE_BODY; + } elsif ($state == STATE_BODY_MAYBE) { # Continued declaration purpose chomp($declaration_purpose); $declaration_purpose .= " " . $1;