Skip to content

Address issues with SPDX requirements and PEP-263

Mauro Carvalho Chehab linux-doc linux-media lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest6 patches 13 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6docs: sphinx: add SPDX header for some sphinx extensionsDocumentation/sphinx/kernel_include.py Documentation/sphinx/rstFlatTable.py+2 -00 replies
2/6tools: perf: fix SPDX header in the light of PEP-263tools/perf/python/tracepoint.py tools/perf/python/twatch.py+2 -40 replies
3/6tools: intel_pstate_tracer.py: fix SPDX header in the light of PEP-263tools/power/x86/intel_pstate_tracer/intel_pstate_tracer.py+1 -10 replies
4/6docs: license-rules.txt: cover SPDX headers on Python scriptsDocumentation/process/license-rules.rst+5 -20 replies
5/6scripts/spdxcheck.py: keep track on what line SPDX header was foundscripts/spdxcheck.py+28 -90 replies
6/6scripts/spdxcheck.py: check if the line number follows the strict rulescripts/spdxcheck.py+25 -91 reply

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/6] Address issues with SPDX requirements and PEP-263

The description at Documentation/process/license-rules.rst is very strict with regards to the position where the SPDX tags should be.

In the past several developers and maintainers interpreted it on a more permissive way, placing the SPDX header between lines 1 to 15, with are the ones which the scripts/spdxcheck.py script verifies.

However, recently, devs are becoming more strict about such requirement and want it to strictly follow the rule, with states that the SPDX rule should be at the first line ever on most files, and at the second line for scripts.

Well, for Python script, such requirement causes violation to PEP-263, making regressions on scripts that contain encoding lines, as PEP-263 also states about the same.

This series addresses it.

Patches 1 to 3 fix some Python scripts that violates PEP-263;

Patch 4 mentions PEP-263 for Python scripts, allowing to go up to line 3, when both "#!" and the encoding line is found;

Patch 5 changes the scripts/spdxcheck.py for it to identify on what line each SPDX header is found, optinally allowing to print an histogram about that;

Patch 6 adds a pedantic^Wstrict mode to scripts/spdxcheck.py, making it to also check for violations at the line with contains the SPDX header.

PS.: I sent already a RFC version for those patches along with this thread:

    https://lore.kernel.org/lkml/[email protected]/

Mauro Carvalho Chehab (6):
docs: sphinx: add SPDX header for some sphinx extensions
tools: perf: fix SPDX header in the light of PEP-263
tools: intel_pstate_tracer.py: fix SPDX header in the light of PEP-263
docs: license-rules.txt: cover SPDX headers on Python scripts scripts/spdxcheck.py: keep track on what line SPDX header was found scripts/spdxcheck.py: check if the line number follows the strict rule

 Documentation/process/license-rules.rst       |  7 ++-
 Documentation/sphinx/kernel_include.py        |  1 +
 Documentation/sphinx/rstFlatTable.py          |  1 +
 scripts/spdxcheck.py                          | 55 +++++++++++++++----
 tools/perf/python/tracepoint.py               |  3 +-
 tools/perf/python/twatch.py                   |  3 +-
 .../intel_pstate_tracer.py                    |  2 +-
 7 files changed, 55 insertions(+), 17 deletions(-)
Signature · 1 line
2.21.0