linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Joe Perches <joe@perches.com>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Jessica Yu <jeyu@kernel.org>,
	Federico Vaga <federico.vaga@vaga.pv.it>,
	Thomas Gleixner <tglx@linutronix.de>,
	linux-doc@vger.kernel.org
Subject: [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts
Date: Thu,  5 Sep 2019 06:23:13 -0300	[thread overview]
Message-ID: <88e638eb959095ab6657d295f9f8c27169569bf2.1567675272.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <20190905055614.7958918b@coco.lan>

The author of the license-rules.rst file wanted to be very restrict
with regards to the location of the SPDX header. It says that
the SPDX header "shall be added at the first  possible line in
a file which can contain a comment". Not happy with this already
restrictive requiement, it goes further:

"For the majority  of files this is the first line, except for
scripts", opening an exception to have the SPDX header at the
second line, if the first line starts with "#!".

Well, it turns that this is too restrictive for Python scripts,
and may cause regressions if this would be enforced.

As mentioned on:
	https://stackoverflow.com/questions/728891/correct-way-to-define-python-source-code-encoding

Python's PEP-263 [1] dictates that an script that needs to default to
UTF-8 encoding has to follow this rule:

	'Python will default to ASCII as standard encoding if no other
	 encoding hints are given.

	 To define a source code encoding, a magic comment must be placed
	 into the source files either as first or second line in the file'

And:
	'More precisely, the first or second line must match the following
	 regular expression:

	 ^[ \t\f]*#.*?coding[:=][ \t]*([-_.a-zA-Z0-9]+)'

[1] https://www.python.org/dev/peps/pep-0263/

If a script has both "#!" and the charset encoding line, we can't place
a SPDX tag without either violating license-rules.rst or breaking the
script by making it crash with non-ASCII characters.

So, add a sort notice saying that, for Python scripts, the SPDX
header may be up to the third line, in order to cover the case
where both "#!" and "# .*coding.*UTF-8" lines are found.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/process/license-rules.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Documentation/process/license-rules.rst b/Documentation/process/license-rules.rst
index 2ef44ada3f11..5d23e3498b1c 100644
--- a/Documentation/process/license-rules.rst
+++ b/Documentation/process/license-rules.rst
@@ -64,9 +64,12 @@ License identifier syntax
    possible line in a file which can contain a comment.  For the majority
    of files this is the first line, except for scripts which require the
    '#!PATH_TO_INTERPRETER' in the first line.  For those scripts the SPDX
-   identifier goes into the second line.
+   identifier goes into the second line\ [1]_.
 
-|
+.. [1] Please notice that Python scripts may also need an encoding rule
+   as defined on PEP-263, which should be defined either at the first
+   or the second line. So, for such scripts, the SPDX identifier may
+   go up to the third line.
 
 2. Style:
 
-- 
2.21.0



  reply	other threads:[~2019-09-05  9:23 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-31 15:11 [PATCH] media: siano: Use the correct style for SPDX License Identifier Nishad Kamdar
2019-09-04 18:34 ` Mauro Carvalho Chehab
2019-09-04 18:36   ` Greg Kroah-Hartman
2019-09-04 19:00     ` Mauro Carvalho Chehab
2019-09-04 19:26       ` Joe Perches
2019-09-05  5:54       ` Greg Kroah-Hartman
2019-09-05  8:56         ` Mauro Carvalho Chehab
2019-09-05  9:23           ` Mauro Carvalho Chehab [this message]
2019-09-05  9:27             ` [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts Greg Kroah-Hartman
2019-09-05 10:50               ` Mauro Carvalho Chehab
2019-09-05 11:01                 ` [PATCH 1/3] docs: sphinx: add SPDX header for some sphinx extensions Mauro Carvalho Chehab
2019-09-05 11:01                   ` [PATCH 2/3] tools: perf: fix SPDX header in the light of PEP-263 Mauro Carvalho Chehab
2019-09-05 11:01                   ` [PATCH 3/3] tools: intel_pstate_tracer.py: " Mauro Carvalho Chehab
2019-09-05 12:07               ` [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts Mauro Carvalho Chehab
2019-09-05 17:45                 ` Joe Perches
2019-09-06 11:34                   ` Mauro Carvalho Chehab
2019-09-06 11:37                     ` Mauro Carvalho Chehab
2019-09-06 12:20                     ` Joe Perches
2019-09-06 14:45                       ` Mauro Carvalho Chehab
2019-09-06 16:20                         ` Joe Perches
2019-09-06 17:33                     ` Joe Perches
2019-09-06 18:17                       ` Mauro Carvalho Chehab
2019-09-06 18:30                         ` Joe Perches
2019-09-06 18:12                     ` [RFC PATCH] tools: Add SPDX license to man pages Joe Perches
2019-09-06 19:53                       ` Mauro Carvalho Chehab
2019-09-05 12:57             ` [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts Jonathan Corbet
2019-09-05 14:17               ` Greg Kroah-Hartman
2019-09-05 17:10                 ` Mauro Carvalho Chehab
2019-09-06 16:41                 ` Markus Heiser
2019-09-05 19:28               ` Mauro Carvalho Chehab
2019-09-05 19:40                 ` Jonathan Corbet
2019-09-05 20:07                   ` Mauro Carvalho Chehab
2019-09-06 15:18                     ` Markus Heiser
2019-09-05  9:28           ` [PATCH] media: siano: Use the correct style for SPDX License Identifier Joe Perches
2019-09-05 10:46             ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=88e638eb959095ab6657d295f9f8c27169569bf2.1567675272.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=federico.vaga@vaga.pv.it \
    --cc=gregkh@linuxfoundation.org \
    --cc=jeyu@kernel.org \
    --cc=joe@perches.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=tglx@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).