Re: Documentation/, SPDX tags, and checkpatch.pl

From: John Hubbard
Date: Mon Oct 14 2019 - 17:02:05 EST


On 10/14/19 1:55 PM, Joe Perches wrote:
> On Mon, 2019-10-14 at 13:47 -0700, John Hubbard wrote:
>> Hi,
>>
>> When adding a new Documentation/ file, checkpatch.pl is warning me
>> that the SPDX tag is missing. Should checkpatch.pl skip those kinds
>> of warnings, seeing as how we probably don't intend on putting the
>> SPDX tags at the top of the Documentation/*.rst files?
>>
>> Or are we, after all? I'm just looking to get to a warnings-free situation
>> here, one way or the other. :)
>>
>> The exact warning I'm seeing is:
>>
>> WARNING: Missing or malformed SPDX-License-Identifier tag in line 1
>> #25: FILE: Documentation/vm/get_user_pages.rst:1:
>> +.. _get_user_pages:
>>
>
> Looks like ~18% of the .rst files already have SPDX markers
>
> $ git ls-files -- '*.rst' | wc -l
> 2125
>
> $ git grep -n "SPDX-License-Identifier:" -- '*.rst'| grep ':1:' | wc -l
> 378
>
> Likely all .rst files will have these markers eventually.
>

hah, I had tunnel vision: none of the Documentation/vm/*.rst files that I
was looking at as examples had the tags.

I'll add the tag, sorry about the confusion and thanks for the quick
response!

thanks,

John Hubbard
NVIDIA