diff mbox

platform/x86: dell-rbtn: Block comments use * on subsequent lines

Message ID 20171213082301.23209-1-dhaval.shah@softnautics.com (mailing list archive)
State Rejected, archived
Delegated to: Andy Shevchenko
Headers show

Commit Message

Dhaval Shah Dec. 13, 2017, 8:23 a.m. UTC
Resolved Block comments use * on subsequent lines checkpatch warnings.
Issue found by checkpatch.

Signed-off-by: Dhaval Shah <dhaval.shah@softnautics.com>
---
 drivers/platform/x86/dell-rbtn.c | 26 +++++++++++++-------------
 drivers/platform/x86/dell-rbtn.h | 26 +++++++++++++-------------
 2 files changed, 26 insertions(+), 26 deletions(-)

Comments

Philippe Ombredanne Dec. 13, 2017, 9:24 a.m. UTC | #1
Dhaval,

On Wed, Dec 13, 2017 at 9:23 AM, Dhaval Shah
<dhaval.shah@softnautics.com> wrote:
> Resolved Block comments use * on subsequent lines checkpatch warnings.
> Issue found by checkpatch.
>
> Signed-off-by: Dhaval Shah <dhaval.shah@softnautics.com>
> ---
>  drivers/platform/x86/dell-rbtn.c | 26 +++++++++++++-------------
>  drivers/platform/x86/dell-rbtn.h | 26 +++++++++++++-------------
>  2 files changed, 26 insertions(+), 26 deletions(-)
>
> diff --git a/drivers/platform/x86/dell-rbtn.c b/drivers/platform/x86/dell-rbtn.c
> index f3afe778001e..cab93c6dcd34 100644
> --- a/drivers/platform/x86/dell-rbtn.c
> +++ b/drivers/platform/x86/dell-rbtn.c
> @@ -1,17 +1,17 @@
>  /*
> -    Dell Airplane Mode Switch driver
> -    Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> -
> -    This program is free software; you can redistribute it and/or modify
> -    it under the terms of the GNU General Public License as published by
> -    the Free Software Foundation; either version 2 of the License, or
> -    (at your option) any later version.
> -
> -    This program is distributed in the hope that it will be useful,
> -    but WITHOUT ANY WARRANTY; without even the implied warranty of
> -    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> -    GNU General Public License for more details.
> -*/
> + *   Dell Airplane Mode Switch driver
> + *   Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> + *
> + *   This program is free software; you can redistribute it and/or modify
> + *   it under the terms of the GNU General Public License as published by
> + *   the Free Software Foundation; either version 2 of the License, or
> + *   (at your option) any later version.
> + *
> + *   This program is distributed in the hope that it will be useful,
> + *   but WITHOUT ANY WARRANTY; without even the implied warranty of
> + *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> + *   GNU General Public License for more details.
> + */

Do you mind using the new SPDX ids instead of this long legalese?
You can check the doc patches from Thomas for details [1]

[1] https://lkml.org/lkml/2017/12/4/934
Dhaval Shah Dec. 13, 2017, 9:52 a.m. UTC | #2
HI

Thanks a lot for the review.
Philippe Ombredanne Dec. 13, 2017, 10:01 a.m. UTC | #3
Dhaval,

On Wed, Dec 13, 2017 at 10:52 AM, Dhaval Shah
<dhaval.shah@softnautics.com> wrote:
> HI
>
> Thanks a lot for the review.
> ________________________________________
>> From: Philippe Ombredanne <pombredanne@nexb.com>
>> Sent: Wednesday, December 13, 2017 2:54 PM
>> To: Dhaval Shah
>> Cc: pali.rohar@gmail.com; Darren Hart; Andy Shevchenko; platform-driver-x86@vger.kernel.org; LKML
>> Subject: Re: [PATCH] platform/x86: dell-rbtn: Block comments use * on subsequent lines
>>
>> Dhaval,
>>
>> On Wed, Dec 13, 2017 at 9:23 AM, Dhaval Shah
>> <dhaval.shah@softnautics.com> wrote:
>> > Resolved Block comments use * on subsequent lines checkpatch warnings.
>> > Issue found by checkpatch.
>> >
>> > Signed-off-by: Dhaval Shah <dhaval.shah@softnautics.com>
>> > ---
>> >  drivers/platform/x86/dell-rbtn.c | 26 +++++++++++++-------------
>> >  drivers/platform/x86/dell-rbtn.h | 26 +++++++++++++-------------
>> >  2 files changed, 26 insertions(+), 26 deletions(-)
>> >
>> > diff --git a/drivers/platform/x86/dell-rbtn.c b/drivers/platform/x86/dell-rbtn.c
>> > index f3afe778001e..cab93c6dcd34 100644
>> > --- a/drivers/platform/x86/dell-rbtn.c
>> > +++ b/drivers/platform/x86/dell-rbtn.c
>> > @@ -1,17 +1,17 @@
>> >  /*
>> > -    Dell Airplane Mode Switch driver
>> > -    Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
>> > -
>> > -    This program is free software; you can redistribute it and/or modify
>> > -    it under the terms of the GNU General Public License as published by
>> > -    the Free Software Foundation; either version 2 of the License, or
>> > -    (at your option) any later version.
>> > -
>> > -    This program is distributed in the hope that it will be useful,
>> > -    but WITHOUT ANY WARRANTY; without even the implied warranty of
>> > -    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>> > -    GNU General Public License for more details.
>> > -*/
>> > + *   Dell Airplane Mode Switch driver
>> > + *   Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
>> > + *
>> > + *   This program is free software; you can redistribute it and/or modify
>> > + *   it under the terms of the GNU General Public License as published by
>> > + *   the Free Software Foundation; either version 2 of the License, or
>> > + *   (at your option) any later version.
>> > + *
>> > + *   This program is distributed in the hope that it will be useful,
>> > + *   but WITHOUT ANY WARRANTY; without even the implied warranty of
>> > + *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>> > + *   GNU General Public License for more details.
>> > + */
>>
>> Do you mind using the new SPDX ids instead of this long legalese?
>> You can check the doc patches from Thomas for details [1]
>>
>>
>> [1] https://lkml.org/lkml/2017/12/4/934
> This is different issue. If we need to fix the issue of this if we update SPDX licensing as well.
> I am agree with you on the use of the new SPDX IDs instead of the long legalese.
> For this, we have to add the text "// SPDX-License-Identifier: GPL-2.0" at the top of the file and remove the
> whole license part and keep on copyright and Author name related info. After change, it looks like
> // SPDX-License-Identifier: GPL-2.0
> /*
>  *  Dell Airplane Mode Switch driver
>  *  Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
>  */

And for a short comment block like this, Linus preference is to avoid
mixing comment style and go all the way C++ style as in:

> // SPDX-License-Identifier: GPL-2.0
> // Dell Airplane Mode Switch driver
> // Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>

... for even less boilerplate ;)

See Linus comments for a rationale [1] [2] [3] [4] [5]

[1] https://lkml.org/lkml/2017/11/25/133
[2] https://lkml.org/lkml/2017/11/25/125
[3] https://lkml.org/lkml/2017/11/2/715
[4] https://lkml.org/lkml/2017/11/2/805
Dhaval Shah Dec. 13, 2017, 10:53 a.m. UTC | #4
Hi Philippe,



> From: Philippe Ombredanne <pombredanne@nexb.com>
> Sent: Wednesday, December 13, 2017 3:31 PM
> To: Dhaval Shah
> Cc: pali.rohar@gmail.com; Darren Hart; Andy Shevchenko; platform-driver-x86@vger.kernel.org; LKML
> Subject: Re: [PATCH] platform/x86: dell-rbtn: Block comments use * on subsequent lines
>   

> Dhaval,
> 
> On Wed, Dec 13, 2017 at 10:52 AM, Dhaval Shah
> <dhaval.shah@softnautics.com> wrote:
> > HI
> >
> > Thanks a lot for the review.
> > ________________________________________
> > > From: Philippe Ombredanne <pombredanne@nexb.com>
> > > Sent: Wednesday, December 13, 2017 2:54 PM
> > > To: Dhaval Shah
> > > Cc: pali.rohar@gmail.com; Darren Hart; Andy Shevchenko; platform-driver-x86@vger.kernel.org; LKML
> > > Subject: Re: [PATCH] platform/x86: dell-rbtn: Block comments use * on subsequent lines
> > >
> > > Dhaval,
> > >
> > > On Wed, Dec 13, 2017 at 9:23 AM, Dhaval Shah
> > > <dhaval.shah@softnautics.com> wrote:
> > > > Resolved Block comments use * on subsequent lines checkpatch warnings.
> > > > Issue found by checkpatch.
> > > >
> > > > Signed-off-by: Dhaval Shah <dhaval.shah@softnautics.com>
> > > > ---
> > > >  drivers/platform/x86/dell-rbtn.c | 26 +++++++++++++-------------
> > > >  drivers/platform/x86/dell-rbtn.h | 26 +++++++++++++-------------
> > > >  2 files changed, 26 insertions(+), 26 deletions(-)
> > > >
> > > > diff --git a/drivers/platform/x86/dell-rbtn.c b/drivers/platform/x86/dell-rbtn.c
> > > > index f3afe778001e..cab93c6dcd34 100644
> > > > --- a/drivers/platform/x86/dell-rbtn.c
> > > > +++ b/drivers/platform/x86/dell-rbtn.c
> > > > @@ -1,17 +1,17 @@
> > > >  /*
> > > > -    Dell Airplane Mode Switch driver
> > > > -    Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> > > > -
> > > > -    This program is free software; you can redistribute it and/or modify
> > > > -    it under the terms of the GNU General Public License as published by
> > > > -    the Free Software Foundation; either version 2 of the License, or
> > > > -    (at your option) any later version.
> > > > -
> > > > -    This program is distributed in the hope that it will be useful,
> > > > -    but WITHOUT ANY WARRANTY; without even the implied warranty of
> > > > -    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> > > > -    GNU General Public License for more details.
> > > > -*/
> > > > + *   Dell Airplane Mode Switch driver
> > > > + *   Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> > > > + *
> > > > + *   This program is free software; you can redistribute it and/or modify
> > > > + *   it under the terms of the GNU General Public License as published by
> > > > + *   the Free Software Foundation; either version 2 of the License, or
> > > > + *   (at your option) any later version.
> > > > + *
> > > > + *   This program is distributed in the hope that it will be useful,
> > > > + *   but WITHOUT ANY WARRANTY; without even the implied warranty of
> > > > + *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> > > > + *   GNU General Public License for more details.
> > > > + */
> > >
> > > Do you mind using the new SPDX ids instead of this long legalese?
> > > You can check the doc patches from Thomas for details [1]
> > >
> > >
> > > [1]  https://lkml.org/lkml/2017/12/4/934
> > This is different issue. If we need to fix the issue of this if we update SPDX licensing as well.
> > I am agree with you on the use of the new SPDX IDs instead of the long legalese.
> > For this, we have to add the text "// SPDX-License-Identifier: GPL-2.0" at the top of the file and remove the
> > whole license part and keep on copyright and Author name related info. After change, it looks like
> > // SPDX-License-Identifier: GPL-2.0
> > /*
> >  *  Dell Airplane Mode Switch driver
> >  *  Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> >  */
> 
> And for a short comment block like this, Linus preference is to avoid
> mixing comment style and go all the way C++ style as in:
> 
> > // SPDX-License-Identifier: GPL-2.0
> > // Dell Airplane Mode Switch driver
> > // Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> > 
> > ... for even less boilerplate ;)

Thanks a lot for the link.
Do you want to me to update along with SPDX in this patchset with V2 or we will update in the next patchset once this patch merge?

> > 
> > See Linus comments for a rationale [1] [2] [3] [4] [5]
> > 
> > [1]  https://lkml.org/lkml/2017/11/25/133
> > [2]  https://lkml.org/lkml/2017/11/25/125
> > [3] https://lkml.org/lkml/2017/11/2/715
 > > [4] https://lkml.org/lkml/2017/11/2/805
> 
 >  -- 
 >  Cordially
 >  Philippe Ombredanne
Joe Perches Dec. 13, 2017, 12:25 p.m. UTC | #5
On Wed, 2017-12-13 at 10:53 +0000, Dhaval Shah wrote:
> > > This is different issue. If we need to fix the issue of this if we update SPDX licensing as well.
> > > I am agree with you on the use of the new SPDX IDs instead of the long legalese.
> > > For this, we have to add the text "// SPDX-License-Identifier: GPL-2.0" at the top of the file and remove the
> > > whole license part and keep on copyright and Author name related info. After change, it looks like
> > > // SPDX-License-Identifier: GPL-2.0
> > > /*
> > >   *  Dell Airplane Mode Switch driver
> > >   *  Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> > >   */
> > 
> > And for a short comment block like this, Linus preference is to avoid
> > mixing comment style and go all the way C++ style as in:
> > 
> > > // SPDX-License-Identifier: GPL-2.0
> > > // Dell Airplane Mode Switch driver
> > > // Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> > > 
> > > ... for even less boilerplate ;)
> 
> Thanks a lot for the link.
> Do you want to me to update along with SPDX in this patchset with V2 or we will update in the next patchset once this patch merge?

If anyone does conversions of these license texts
you have to be _extremely_ careful about what
specific license identifier you use.

This license includes the text
	"or (at your option) any later version"
which is not the same as using
	SPDX-License-Identifier: GPL-2.0
Dhaval Shah Dec. 13, 2017, 12:41 p.m. UTC | #6
Hi Joe,
Philippe Ombredanne Dec. 13, 2017, 12:57 p.m. UTC | #7
Dhaval,

On Wed, Dec 13, 2017 at 11:47 AM, Dhaval Shah
<dhaval.shah@softnautics.com> wrote:

<snip>
> > And for a short comment block like this, Linus preference is to avoid
> > mixing comment style and go all the way C++ style as in:
> >
> > > // SPDX-License-Identifier: GPL-2.0
> > > // Dell Airplane Mode Switch driver
> > > // Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
> > >
> > > ... for even less boilerplate ;)
>
> Thanks a lot for the link.
> Do you want to me to update along with SPDX in this patchset with V2 or we will update in the next patchset once this patch merge?

That's not for me to decide, I am just a lowly licensing elf helper scruffy!

PS: you might want to avoid sending HTML email on lkml, FWIW.
Pali Rohár Dec. 13, 2017, 1:07 p.m. UTC | #8
On Wednesday 13 December 2017 12:41:03 Dhaval Shah wrote:
> I have given this SPDX ID based on the current license info in the driver. Yeah. I give the authority to author pali.rohar@gmail.com to decide the SPDX text.

Hi! I think that license of this module is clear and does not need more
comments. Part "either version 2 of the License, or (at your option) any
later version." expresses what it exactly mean and it is standard
license also used by other projects.
Dhaval Shah Dec. 13, 2017, 1:08 p.m. UTC | #9
Hi Philippe,
Joe Perches Dec. 13, 2017, 3:39 p.m. UTC | #10
On Wed, 2017-12-13 at 12:41 +0000, Dhaval Shah wrote:
> > If anyone does conversions of these license texts
> > you have to be _extremely_ careful about what
> > specific license identifier you use.
> > This license includes the text
> >         "or (at your option) any later version"
> > which is not the same as using
> >         SPDX-License-Identifier: GPL-2.0
> 
> I have given this SPDX ID based on the current license info in the driver.

No, you have not.
You have done it incorrectly.

For a short description, read:
https://spdx.org/sites/cpstandard/files/pages/files/using_spdx_license_list_short_identifiers.pdf
page 5
Dhaval Shah Dec. 14, 2017, 9:12 a.m. UTC | #11

Andy Shevchenko Dec. 14, 2017, 5:56 p.m. UTC | #12
On Thu, Dec 14, 2017 at 11:12 AM, Dhaval Shah
<dhaval.shah@softnautics.com> wrote:

> I got your point. SPDX text should be "SPDX-License-Identifier: GPL-2.0+".
> Am i Right?

Whatever you come up with I will apply taking into consideration the following:
1. Linus' preference over comment style.
2. Module author(s) blessing for the change.

Without above on the table I would not even look into the message.

P.S. And personally I'm a bit sceptical about standalone (coment)
style changes. I would rather not to apply anything like this without
real need.
diff mbox

Patch

diff --git a/drivers/platform/x86/dell-rbtn.c b/drivers/platform/x86/dell-rbtn.c
index f3afe778001e..cab93c6dcd34 100644
--- a/drivers/platform/x86/dell-rbtn.c
+++ b/drivers/platform/x86/dell-rbtn.c
@@ -1,17 +1,17 @@ 
 /*
-    Dell Airplane Mode Switch driver
-    Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-*/
+ *   Dell Airplane Mode Switch driver
+ *   Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
+ *
+ *   This program is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation; either version 2 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ */
 
 #include <linux/module.h>
 #include <linux/acpi.h>
diff --git a/drivers/platform/x86/dell-rbtn.h b/drivers/platform/x86/dell-rbtn.h
index c59cc6b8ec2b..46337b22f00d 100644
--- a/drivers/platform/x86/dell-rbtn.h
+++ b/drivers/platform/x86/dell-rbtn.h
@@ -1,17 +1,17 @@ 
 /*
-    Dell Airplane Mode Switch driver
-    Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-*/
+ *   Dell Airplane Mode Switch driver
+ *   Copyright (C) 2014-2015  Pali Rohár <pali.rohar@gmail.com>
+ *
+ *   This program is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation; either version 2 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ */
 
 #ifndef _DELL_RBTN_H_
 #define _DELL_RBTN_H_