linux-kernel - Re: [PATCH v2 1/1] A compact idiom to add code examples in kerneldoc comments.

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: <20200326192947.GM22483@bombadil.infradead.org>
Date:   Thu, 26 Mar 2020 12:29:47 -0700
From:   Matthew Wilcox <willy@...radead.org>
To:     peter@...eshed.quignogs.org.uk
Cc:     linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael@...nel.org>, linux-doc@...r.kernel.org,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH v2 1/1] A compact idiom to add code examples in kerneldoc
 comments.

On Thu, Mar 26, 2020 at 07:16:28PM +0000, peter@...eshed.quignogs.org.uk wrote:
> From: Peter Lister <peter@...eshed.quignogs.org.uk>
> 
> scripts/kernel-doc - When a double colon follows a section heading
> (e.g. Example::), write a double colon line to the ReST output to make
> the following text (e.g. a code snippet) into a literal block.

I think this is a good idea

> -
> +    # $doc_sect is a regex which searches for section names.
> +    # If it matches:
> +    #   $1 is the section name
> +    #   $2 is a colon if the section name was followed by a double colon.
> +    #   $3 the rest of the content after the colon (or double colon).

I would add an extra 'is' after $3.

>      if (/$doc_sect/i) { # case insensitive for supported section names
>  	$newsection = $1;
> -	$newcontents = $2;
> -
> +	# If $2 is ':', the section name was followed by a double
> +	# colon, so insert a containing just '::' to make the

Missing word between 'a' and 'containing'?