Linux GPIO subsystem development
 help / color / mirror / Atom feed
From: "Erik Schilling" <erik.schilling@linaro.org>
To: "Phil Howard" <phil@gadgetoid.com>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
	"Kent Gibson" <warthog618@gmail.com>,
	"Bartosz Golaszewski" <brgl@bgdev.pl>
Cc: <linux-gpio@vger.kernel.org>
Subject: Re: [libgpiod][PATCH] bindings: python: fix README.md SPDX license tags
Date: Mon, 06 Nov 2023 14:00:23 +0100	[thread overview]
Message-ID: <CWRQXOJ5TFLJ.1NYFSAPXR0HCY@ablu-work> (raw)
In-Reply-To: <20231103191455.2441883-1-phil@gadgetoid.com>

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>


  reply	other threads:[~2023-11-06 13:00 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-03 19:14 [libgpiod][PATCH] bindings: python: fix README.md SPDX license tags Phil Howard
2023-11-06 13:00 ` Erik Schilling [this message]
2023-11-06 14:41   ` Phil Howard

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=CWRQXOJ5TFLJ.1NYFSAPXR0HCY@ablu-work \
    --to=erik.schilling@linaro.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=brgl@bgdev.pl \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=phil@gadgetoid.com \
    --cc=warthog618@gmail.com \
    /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