[libgpiod][PATCH] bindings: python: fix README.md SPDX license tags

[libgpiod][PATCH] bindings: python: fix README.md SPDX license tags

[Phil Howard]

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

Signed-off-by: Phil Howard <phil@gadgetoid.com>
---
 bindings/python/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/bindings/python/README.md b/bindings/python/README.md
index abb69da..325c63d 100644
--- a/bindings/python/README.md
+++ b/bindings/python/README.md
@@ -1,5 +1,5 @@
-# SPDX-License-Identifier: CC-BY-SA-4.0
-# SPDX-FileCopyrightText: 2023 Phil Howard <phil@gadgetoid.com>
+<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
+<!-- SPDX-FileCopyrightText: 2023 Phil Howard <phil@gadgetoid.com> -->
 
 # gpiod
 
-- 
2.34.1

Re: [libgpiod][PATCH] bindings: python: fix README.md SPDX license tags

[Erik Schilling]

On Fri Nov 3, 2023 at 8:14 PM CET, Phil Howard wrote:
> Replace the # (which is a markdown heading) with HTML tags to hide SPDX
> identifier tags within the project description on pypi.
>
> Signed-off-by: Phil Howard <phil@gadgetoid.com>
> ---
>  bindings/python/README.md | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/bindings/python/README.md b/bindings/python/README.md
> index abb69da..325c63d 100644
> --- a/bindings/python/README.md
> +++ b/bindings/python/README.md
> @@ -1,5 +1,5 @@
> -# SPDX-License-Identifier: CC-BY-SA-4.0
> -# SPDX-FileCopyrightText: 2023 Phil Howard <phil@gadgetoid.com>
> +<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
> +<!-- SPDX-FileCopyrightText: 2023 Phil Howard <phil@gadgetoid.com> -->

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.

Acked-by: Erik Schilling <erik.schilling@linaro.org>

[1]:
  commit fd25c0ea05fec3997f44d986b2fb904ba029e812
  Author: Erik Schilling <erik.schilling@linaro.org>
  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
    
      Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
      Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
      Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

Re: [libgpiod][PATCH] bindings: python: fix README.md SPDX license tags

[Phil Howard]

On Mon, 6 Nov 2023 at 13:00, Erik Schilling <erik.schilling@linaro.org> wrote:
>
> On Fri Nov 3, 2023 at 8:14 PM CET, Phil Howard wrote:
> > Replace the # (which is a markdown heading) with HTML tags to hide SPDX
> > identifier tags within the project description on pypi.
> >
> > Signed-off-by: Phil Howard <phil@gadgetoid.com>
> > ---
> >  bindings/python/README.md | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/bindings/python/README.md b/bindings/python/README.md
> > index abb69da..325c63d 100644
> > --- a/bindings/python/README.md
> > +++ b/bindings/python/README.md
> > @@ -1,5 +1,5 @@
> > -# SPDX-License-Identifier: CC-BY-SA-4.0
> > -# SPDX-FileCopyrightText: 2023 Phil Howard <phil@gadgetoid.com>
> > +<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
> > +<!-- SPDX-FileCopyrightText: 2023 Phil Howard <phil@gadgetoid.com> -->
>
> 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)

>
> Acked-by: Erik Schilling <erik.schilling@linaro.org>
>
> [1]:
>   commit fd25c0ea05fec3997f44d986b2fb904ba029e812
>   Author: Erik Schilling <erik.schilling@linaro.org>
>   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
>
>       Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
>       Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
>       Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>


-- 
Phil