[lkml]   [2019]   [Sep]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: [PATCH 0/6] Address issues with SPDX requirements and PEP-263
On Sat, 7 Sep 2019, Markus Heiser wrote:
> Am 07.09.19 um 20:04 schrieb Mauro Carvalho Chehab:
> > No idea. I would actually prefer to just remove the restriction, and let
> > the SPDX header to be anywhere inside the first comment block inside a
> > file [2].
> > That's basically how this thread started: other developers think
> > that it is a good idea to be pedantic. So, be it, but let's then fix
> > the documentation, as the way it is, it is implicitly forbidding the
> > addition of encoding lines for Python scripts.
> >
> > [2] I *suspect* that the restriction was added in order to make
> > ./scripts/ to run faster and to avoid false positives.
> > Right now, if the maximum limit is removed (or set to a very high
> > value), there will be one false positive:

Nope. The intention was to have a well define place and format instead of
everyone and his dog deciding to put it somewhere. SPDX is not intended to
replace the existing licensing mess with some other randomly placed and
formatted licensing mess.

> > > - write a shebang line if this file is called directly from the
> > > command line .. but we do not need shebangs on py modules which
> > > are imported from other modules or scripts
> > >
> > > - write a encoding line if it is need or helpful / mostly it is helpful
> > > to know the encoding of a text/code file.
> > >
> > > - add a SPDX tag
> >
> > Yes, but this violates the current documentation, as it doesn't allow the
> > SPDX tag after line #2.
> Thats what I mean: The documentation was written with only a small use-cases
> in mind .. there is no real need for SPDX to be in line one or two ... lets
> fix the documentation as I described before.

If there is a requirement from the language to have 2 lines right at the
top for conveying information then there is of course no reason to insist
on the SPDX identifier being on line 2.

So the documentation should say:

The SPDX identifier must be at the first possible line at the top of the
file which is not occupied by information which is required to be
immediately at the top of the file by system constraints, e.g. shebang,
or by the language, e.g. the encoding information for python.

or something to that effect.



 \ /
  Last update: 2019-09-07 23:18    [W:0.053 / U:1.720 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site