linux-kernel - Re: [PATCH] platform/x86: dell-rbtn: Block comments use * on subsequent lines

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: <CAOFm3uGEmR9Wq1O06CiaqncA4E7mxfgDm97NetOe0qL_mtpsSw@mail.gmail.com>
Date:   Wed, 13 Dec 2017 11:01:39 +0100
From:   Philippe Ombredanne <pombredanne@...b.com>
To:     Dhaval Shah <dhaval.shah@...tnautics.com>
Cc:     "pali.rohar@...il.com" <pali.rohar@...il.com>,
        Darren Hart <dvhart@...radead.org>,
        Andy Shevchenko <andy@...radead.org>,
        "platform-driver-x86@...r.kernel.org" 
        <platform-driver-x86@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>
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@...tnautics.com> wrote:
> HI
>
> Thanks a lot for the review.
> ________________________________________
>> From: Philippe Ombredanne <pombredanne@...b.com>
>> Sent: Wednesday, December 13, 2017 2:54 PM
>> To: Dhaval Shah
>> Cc: pali.rohar@...il.com; Darren Hart; Andy Shevchenko; platform-driver-x86@...r.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@...tnautics.com> wrote:
>> > Resolved Block comments use * on subsequent lines checkpatch warnings.
>> > Issue found by checkpatch.
>> >
>> > Signed-off-by: Dhaval Shah <dhaval.shah@...tnautics.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@...il.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@...il.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@...il.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@...il.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

-- 
Cordially
Philippe Ombredanne