diff mbox series

[libgpiod,v2,1/2] rust: bindings: turn SPDX tags into comments

Message ID 20230522-crates-io-v2-1-d8de75e7f584@linaro.org
State New
Headers show
Series bindings: rust: allow packaging of libgpiod-sys | expand

Commit Message

Erik Schilling May 26, 2023, 3:27 p.m. UTC
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>
---
 bindings/rust/gpiosim-sys/README.md  | 8 +++++---
 bindings/rust/libgpiod-sys/README.md | 8 +++++---
 2 files changed, 10 insertions(+), 6 deletions(-)

Comments

Bartosz Golaszewski May 30, 2023, 4:05 p.m. UTC | #1
On Fri, May 26, 2023 at 5:28 PM Erik Schilling
<erik.schilling@linaro.org> wrote:
>
> 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>
> ---
>  bindings/rust/gpiosim-sys/README.md  | 8 +++++---
>  bindings/rust/libgpiod-sys/README.md | 8 +++++---
>  2 files changed, 10 insertions(+), 6 deletions(-)
>
> diff --git a/bindings/rust/gpiosim-sys/README.md b/bindings/rust/gpiosim-sys/README.md
> index 6cd24d9..b13f09a 100644
> --- a/bindings/rust/gpiosim-sys/README.md
> +++ b/bindings/rust/gpiosim-sys/README.md
> @@ -1,6 +1,8 @@
> -# SPDX-License-Identifier: CC0-1.0
> -# SPDX-FileCopyrightText: 2022 Linaro Ltd.
> -# SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
> +<!--
> +SPDX-License-Identifier: CC0-1.0
> +SPDX-FileCopyrightText: 2022 Linaro Ltd.
> +SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
> +-->
>
>  # Generated gpiosim Rust FFI bindings
>  Automatically generated Rust FFI bindings via
> diff --git a/bindings/rust/libgpiod-sys/README.md b/bindings/rust/libgpiod-sys/README.md
> index 3eb5c9d..1cb3b0a 100644
> --- a/bindings/rust/libgpiod-sys/README.md
> +++ b/bindings/rust/libgpiod-sys/README.md
> @@ -1,6 +1,8 @@
> -# SPDX-License-Identifier: CC0-1.0
> -# SPDX-FileCopyrightText: 2022 Linaro Ltd.
> -# SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
> +<!--
> +SPDX-License-Identifier: CC0-1.0
> +SPDX-FileCopyrightText: 2022 Linaro Ltd.
> +SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
> +-->
>
>  # Generated libgpiod-sys Rust FFI bindings
>  Automatically generated Rust FFI bindings via
>
> --
> 2.40.0
>

Applied. And this made me think I should convert other txt files to markdown...

Bart
diff mbox series

Patch

diff --git a/bindings/rust/gpiosim-sys/README.md b/bindings/rust/gpiosim-sys/README.md
index 6cd24d9..b13f09a 100644
--- a/bindings/rust/gpiosim-sys/README.md
+++ b/bindings/rust/gpiosim-sys/README.md
@@ -1,6 +1,8 @@ 
-# SPDX-License-Identifier: CC0-1.0
-# SPDX-FileCopyrightText: 2022 Linaro Ltd.
-# SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
+<!--
+SPDX-License-Identifier: CC0-1.0
+SPDX-FileCopyrightText: 2022 Linaro Ltd.
+SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
+-->
 
 # Generated gpiosim Rust FFI bindings
 Automatically generated Rust FFI bindings via
diff --git a/bindings/rust/libgpiod-sys/README.md b/bindings/rust/libgpiod-sys/README.md
index 3eb5c9d..1cb3b0a 100644
--- a/bindings/rust/libgpiod-sys/README.md
+++ b/bindings/rust/libgpiod-sys/README.md
@@ -1,6 +1,8 @@ 
-# SPDX-License-Identifier: CC0-1.0
-# SPDX-FileCopyrightText: 2022 Linaro Ltd.
-# SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
+<!--
+SPDX-License-Identifier: CC0-1.0
+SPDX-FileCopyrightText: 2022 Linaro Ltd.
+SPDX-FileCopyrightText: 2022 Viresh Kumar <viresh.kumar@linaro.org>
+-->
 
 # Generated libgpiod-sys Rust FFI bindings
 Automatically generated Rust FFI bindings via