[PATCH] CodingStyle: Remove "Don't use C99-style comments"

[PATCH] CodingStyle: Remove "Don't use C99-style comments"

[Joe Perches]

Because Linus may still be reading source code on greenbar paper
instead of color terminals with code syntax highlighting and
appropriate font decorations.

Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.com

Signed-off-by: Joe Perches <joe@perches.com>
---
 Documentation/CodingStyle | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 9a70ddd..19b2e9c 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -461,9 +461,6 @@ When commenting the kernel API functions, please use the kernel-doc format.
 See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
 for details.
 
-Linux style for comments is the C89 "/* ... */" style.
-Don't use C99-style "// ..." comments.
-
 The preferred style for long (multi-line) comments is:
 
 	/*
-- 
2.8.0.rc4.16.g56331f8

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

[Joe Perches]

On Tue, 2016-07-12 at 17:18 -0700, Joe Perches wrote:
> Because Linus may still be reading source code on greenbar paper
> instead of color terminals with code syntax highlighting and
> appropriate font decorations.
> 
> Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.com
> 
> Signed-off-by: Joe Perches <joe@perches.com>
> ---
>  Documentation/CodingStyle | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
> index 9a70ddd..19b2e9c 100644
> --- a/Documentation/CodingStyle
> +++ b/Documentation/CodingStyle
> @@ -461,9 +461,6 @@ When commenting the kernel API functions, please use the kernel-doc format.
>  See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
>  for details.
>  
> -Linux style for comments is the C89 "/* ... */" style.
> -Don't use C99-style "// ..." comments.
> -
>  The preferred style for long (multi-line) comments is:
>  
>  	/*

ping?

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

[Jonathan Corbet]

On Thu, 04 Aug 2016 10:55:14 -0700
Joe Perches <joe@perches.com> wrote:

> > Because Linus may still be reading source code on greenbar paper
> > instead of color terminals with code syntax highlighting and
> > appropriate font decorations.
> > 
> > Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.com
> > 
> > Signed-off-by: Joe Perches <joe@perches.com>
> > ---
> >  Documentation/CodingStyle | 3 ---
> >  1 file changed, 3 deletions(-)
> > 
> > diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
> > index 9a70ddd..19b2e9c 100644
> > --- a/Documentation/CodingStyle
> > +++ b/Documentation/CodingStyle
> > @@ -461,9 +461,6 @@ When commenting the kernel API functions, please use the kernel-doc format.
> >  See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
> >  for details.
> >  
> > -Linux style for comments is the C89 "/* ... */" style.
> > -Don't use C99-style "// ..." comments.
> > -
> >  The preferred style for long (multi-line) comments is:
> >  
> >  	/*  
> 
> ping?

Sorry, I've not been ignoring this, I've just not yet worked up the
courage to apply it.  Yes, Linus said he's fine with C++-style comments,
but I still expect some pushback when people start actually sending them.
I don't quite feel a sense of community consensus on this one.

Still, what the heck, I'll go ahead and apply it.  We can always revert it
when people start screaming :)

jon

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

[Joe Perches]

On Sun, 2016-08-14 at 12:35 -0600, Jonathan Corbet wrote:
> On Thu, 04 Aug 2016 10:55:14 -0700 Joe Perches <joe@perches.com> wrote:
> > > Because Linus may still be reading source code on greenbar paper
> > > instead of color terminals with code syntax highlighting and
> > > appropriate font decorations.
> > > 
> > > Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.com
[]
> > > diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
[]
> > > @@ -461,9 +461,6 @@ When commenting the kernel API functions, please use the kernel-doc format.
> > >  See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
> > >  for details.
> > >  
> > > -Linux style for comments is the C89 "/* ... */" style.
> > > -Don't use C99-style "// ..." comments.
> > > -
> > >  The preferred style for long (multi-line) comments is:
> > >  
> > >  	/*  
> > ping?
> Sorry, I've not been ignoring this, I've just not yet worked up the
> courage to apply it.  Yes, Linus said he's fine with C++-style comments,
> but I still expect some pushback when people start actually sending them.
> I don't quite feel a sense of community consensus on this one.
> 
> Still, what the heck, I'll go ahead and apply it.  We can always revert it
> when people start screaming :)

;)

Yeah, that was my thought too when I sent the patch for
checkpatch to ignore // comments.

What the heck.

I just don't care that much how people comment their code.

Syntax coloring and highlighting works in every editor I use
except the email client and I should change the one I use
(evolution) one day because it's broken anyway.

cheers, Joe

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

[Randy Dunlap]

On 08/14/16 11:35, Jonathan Corbet wrote:
> On Thu, 04 Aug 2016 10:55:14 -0700
> Joe Perches <joe@perches.com> wrote:
> 
>>> Because Linus may still be reading source code on greenbar paper
>>> instead of color terminals with code syntax highlighting and
>>> appropriate font decorations.
>>>
>>> Link: http://lkml.kernel.org/r/CA+55aFyQYJerovMsSoSKS7PessZBr4vNp-3QUUwhqk4A4_jcbg@mail.gmail.com
>>>
>>> Signed-off-by: Joe Perches <joe@perches.com>
>>> ---
>>>  Documentation/CodingStyle | 3 ---
>>>  1 file changed, 3 deletions(-)
>>>
>>> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
>>> index 9a70ddd..19b2e9c 100644
>>> --- a/Documentation/CodingStyle
>>> +++ b/Documentation/CodingStyle
>>> @@ -461,9 +461,6 @@ When commenting the kernel API functions, please use the kernel-doc format.
>>>  See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
>>>  for details.
>>>  
>>> -Linux style for comments is the C89 "/* ... */" style.
>>> -Don't use C99-style "// ..." comments.
>>> -
>>>  The preferred style for long (multi-line) comments is:
>>>  
>>>  	/*  
>>
>> ping?
> 
> Sorry, I've not been ignoring this, I've just not yet worked up the
> courage to apply it.  Yes, Linus said he's fine with C++-style comments,
> but I still expect some pushback when people start actually sending them.
> I don't quite feel a sense of community consensus on this one.
> 
> Still, what the heck, I'll go ahead and apply it.  We can always revert it
> when people start screaming :)

I like it, but like Linus said, we don't want people to send
patches just to "fix" the comment style.

-- 
~Randy

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

[Joe Perches]

On Sun, 2016-08-14 at 12:09 -0700, Randy Dunlap wrote:

> I like it, but like Linus said, we don't want people to send
> patches just to "fix" the comment style.

Just fyi, checkpatch makes no recommendation about
converting single line comments to //.

And it shouldn't in my opinion.