linux-kernel - Re: [PATCH 6/8] docs: kernel-doc: Move STATE

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <874lmqa4my.fsf@intel.com>
Date:   Fri, 09 Feb 2018 11:33:57 +0200
From:   Jani Nikula <jani.nikula@...ux.intel.com>
To:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, mchehab@...nel.org, me@...in.cc,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH 6/8] docs: kernel-doc: Move STATE_PROTO processing into its own function

On Wed, 07 Feb 2018, Jonathan Corbet <corbet@....net> wrote:
> Move the top-level prototype-processing code out of process_file().
>
> Signed-off-by: Jonathan Corbet <corbet@....net>

Reviewed-by: Jani Nikula <jani.nikula@...el.com>

> ---
>  scripts/kernel-doc | 46 ++++++++++++++++++++++++++++------------------
>  1 file changed, 28 insertions(+), 18 deletions(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index a6a7bb46ea29..2deddb876156 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1965,6 +1965,32 @@ sub process_body($$) {
>  }
>  
>  
> +#
> +# STATE_PROTO: reading a function/whatever prototype.
> +#
> +sub process_proto($$) {
> +    my $file = shift;
> +
> +    if (/$doc_inline_oneline/) {
> +	$section = $1;
> +	$contents = $2;
> +	if ($contents ne "") {
> +	    $contents .= "\n";
> +	    dump_section($file, $section, $contents);
> +	    $section = $section_default;
> +	    $contents = "";
> +	}
> +    } elsif (/$doc_inline_start/) {
> +	$state = STATE_INLINE;
> +	$inline_doc_state = STATE_INLINE_NAME;
> +    } elsif ($decl_type eq 'function') {
> +	process_proto_function($_, $file);
> +    } else {
> +	process_proto_type($_, $file);
> +    }
> +}
> +
> +
>  sub process_file($) {
>      my $file;
>      my $func;
> @@ -2031,24 +2057,8 @@ sub process_file($) {
>  		    ++$warnings;
>  		}
>  	    }
> -	} elsif ($state == STATE_PROTO) {	# scanning for function '{' (end of prototype)
> -	    if (/$doc_inline_oneline/) {
> -		$section = $1;
> -		$contents = $2;
> -		if ($contents ne "") {
> -		    $contents .= "\n";
> -		    dump_section($file, $section, $contents);
> -		    $section = $section_default;
> -		    $contents = "";
> -		}
> -	    } elsif (/$doc_inline_start/) {
> -		$state = STATE_INLINE;
> -		$inline_doc_state = STATE_INLINE_NAME;
> -	    } elsif ($decl_type eq 'function') {
> -		process_proto_function($_, $file);
> -	    } else {
> -		process_proto_type($_, $file);
> -	    }
> +	} elsif ($state == STATE_PROTO) {
> +	    process_proto($file, $_);
>  	} elsif ($state == STATE_DOCBLOCK) {
>  		if (/$doc_end/)
>  		{

-- 
Jani Nikula, Intel Open Source Technology Center