linux-kernel - Re: [PATCH 03/24] rcu/tree: Use consistent style for 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: <20200503234400.GB197097@google.com>
Date:   Sun, 3 May 2020 19:44:00 -0400
From:   Joel Fernandes <joel@...lfernandes.org>
To:     Joe Perches <joe@...ches.com>
Cc:     paulmck@...nel.org, "Uladzislau Rezki (Sony)" <urezki@...il.com>,
        LKML <linux-kernel@...r.kernel.org>, linux-mm@...ck.org,
        Andrew Morton <akpm@...ux-foundation.org>,
        "Theodore Y . Ts'o" <tytso@....edu>,
        Matthew Wilcox <willy@...radead.org>,
        RCU <rcu@...r.kernel.org>,
        Oleksiy Avramchenko <oleksiy.avramchenko@...ymobile.com>
Subject: Re: [PATCH 03/24] rcu/tree: Use consistent style for comments

On Fri, May 01, 2020 at 01:52:46PM -0700, Joe Perches wrote:
> On Fri, 2020-05-01 at 12:05 -0700, Paul E. McKenney wrote:
> > On Tue, Apr 28, 2020 at 10:58:42PM +0200, Uladzislau Rezki (Sony) wrote:
> > > Simple clean up of comments in kfree_rcu() code to keep it consistent
> > > with majority of commenting styles.
> []
> > on /* */ style?
> > 
> > I am (slowly) moving RCU to "//" for those reasons.  ;-)
> 
> I hope c99 comment styles are more commonly used soon too.
> checkpatch doesn't care.
> 
> Perhaps a change to coding-style.rst
> ---
>  Documentation/process/coding-style.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index acb2f1b..fee647 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -565,6 +565,11 @@ comments is a little different.
>  	 * but there is no initial almost-blank line.
>  	 */
>  
> +.. code-block:: c
> +
> +	// Single line and inline comments may also use the c99 // style
> +	// Block comments as well
> +
>  It's also important to comment data, whether they are basic types or derived
>  types.  To this end, use just one data declaration per line (no commas for
>  multiple data declarations).  This leaves you room for a small comment on each
> 
> 

Yeah that's fine with me. This patch just tries to keep it consistent. I am
Ok with either style.

thanks,

 - Joel