Skip to contentSkip to conversation

bindings: python: fix README.md SPDX license tags

PATCH In review Phil Howard 2 participants 3 messages Nov 3, 2023 – Nov 6, 2023 GPIO

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bindings: python: fix README.md SPDX license tags

Replace the # (which is a markdown heading) with HTML tags to hide SPDX identifier tags within the project description on pypi.

---
 bindings/python/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
bindings/python/README.md +2 -2
index abb69da..325c63d 100644
@@ -1,5 +1,5 @@
-# SPDX-License-Identifier: CC-BY-SA-4.0
-# SPDX-FileCopyrightText: 2023 Phil Howard <[email protected]>
+<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
+<!-- SPDX-FileCopyrightText: 2023 Phil Howard <[email protected]> -->
 
 # gpiod
 
Signature · 1 line
2.34.1
Acked-by Acked-by Viresh Kumar on v1 1/1
#1 lore raw
Quoted 13 lines · Phil Howard

Replace the # (which is a markdown heading) with HTML tags to hide SPDX identifier tags within the project description on pypi.

---
 bindings/python/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
bindings/python/README.md +0 -0
index abb69da..325c63d 100644

bindings/python/README.md line 2

Quoted 4 lines
bindings/python/README.md +2 -2
@@ -1,5 +1,5 @@
-# SPDX-License-Identifier: CC-BY-SA-4.0
-# SPDX-FileCopyrightText: 2023 Phil Howard <[email protected]>
+<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
+<!-- SPDX-FileCopyrightText: 2023 Phil Howard <[email protected]> -->

I went with a single block when I fixed this for the Rust bindings [1]. But I got no opinion on which way is better. I guess as long as the tools work it should be fine.

[1]:
commit fd25c0ea05fec3997f44d986b2fb904ba029e812
Author: Erik Schilling <[email protected]>
Date: Fri May 26 17:27:32 2023 +0200

rust: bindings: turn SPDX tags into comments

In markdown # Foo generates a top-level heading. This leads to to some weird, huge SPDX tags being rendered before the start of the actual content.

Lacking good examples, I just took the syntax that reuse addheader[1] outputs.

[1] https://github.com/fsfe/reuse-tool

#2 lore raw
Quoted 10 lines · Erik Schilling
Quoted 8 lines · Phil Howard

Replace the # (which is a markdown heading) with HTML tags to hide SPDX identifier tags within the project description on pypi.

---
 bindings/python/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Quoted 13 lines

bindings/python/README.md line 2

Quoted 9 lines
bindings/python/README.md +2 -2
index abb69da..325c63d 100644
@@ -1,5 +1,5 @@
-# SPDX-License-Identifier: CC-BY-SA-4.0
-# SPDX-FileCopyrightText: 2023 Phil Howard <[email protected]>
+<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
+<!-- SPDX-FileCopyrightText: 2023 Phil Howard <[email protected]> -->

I went with a single block when I fixed this for the Rust bindings [1]. But I got no opinion on which way is better. I guess as long as the tools work it should be fine.

Might be worth doing this for consistency. Also I think I noticed while prepping another
patch that checkpatch.pl was detecting the "-->" on a line as part of the SPDX info.

(Glad I'm not the only one to be caught out by this)

Quoted 23 lines

[1]:
commit fd25c0ea05fec3997f44d986b2fb904ba029e812
Author: Erik Schilling <[email protected]>
Date: Fri May 26 17:27:32 2023 +0200

rust: bindings: turn SPDX tags into comments

In markdown # Foo generates a top-level heading. This leads to to some weird, huge SPDX tags being rendered before the start of the actual content.

Lacking good examples, I just took the syntax that reuse addheader[1] outputs.

[1] https://github.com/fsfe/reuse-tool

Signature · 1 line
Phil