[PATCH] docs: sphinx: remove SPDX/copyright comments from HTML output

[PATCH] docs: sphinx: remove SPDX/copyright comments from HTML output

[Vegard Nossum]

Use Jinja2 comments instead of HTML comments for the SPDX and copyright
lines. This prevents them from appearing in the HTML output, which was
never the intention; the HTML output has its own copyright line at the
bottom of the document.

Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 Documentation/sphinx/templates/kernel-toc.html   | 3 ++-
 Documentation/sphinx/templates/translations.html | 4 ++--
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/sphinx/templates/kernel-toc.html b/Documentation/sphinx/templates/kernel-toc.html
index 41f1efbe64bb2..b84969bd31c4f 100644
--- a/Documentation/sphinx/templates/kernel-toc.html
+++ b/Documentation/sphinx/templates/kernel-toc.html
@@ -1,4 +1,5 @@
-<!-- SPDX-License-Identifier: GPL-2.0 -->
+{# SPDX-License-Identifier: GPL-2.0 #}
+
 {# Create a local TOC the kernel way #}
 <p>
 <h3 class="kernel-toc-contents">Contents</h3>
diff --git a/Documentation/sphinx/templates/translations.html b/Documentation/sphinx/templates/translations.html
index 8df5d42d8dcd8..351586f419386 100644
--- a/Documentation/sphinx/templates/translations.html
+++ b/Documentation/sphinx/templates/translations.html
@@ -1,5 +1,5 @@
-<!-- SPDX-License-Identifier: GPL-2.0 -->
-<!-- Copyright © 2023, Oracle and/or its affiliates. -->
+{# SPDX-License-Identifier: GPL-2.0 #}
+{# Copyright © 2023, Oracle and/or its affiliates. #}
 
 {# Create a language menu for translations #}
 {% if languages|length > 0: %}
-- 
2.34.1

Re: [PATCH] docs: sphinx: remove SPDX/copyright comments from HTML output

[Jonathan Corbet]

Vegard Nossum <vegard.nossum@oracle.com> writes:

> Use Jinja2 comments instead of HTML comments for the SPDX and copyright
> lines. This prevents them from appearing in the HTML output, which was
> never the intention; the HTML output has its own copyright line at the
> bottom of the document.
>
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
> ---
>  Documentation/sphinx/templates/kernel-toc.html   | 3 ++-
>  Documentation/sphinx/templates/translations.html | 4 ++--
>  2 files changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/sphinx/templates/kernel-toc.html b/Documentation/sphinx/templates/kernel-toc.html
> index 41f1efbe64bb2..b84969bd31c4f 100644
> --- a/Documentation/sphinx/templates/kernel-toc.html
> +++ b/Documentation/sphinx/templates/kernel-toc.html
> @@ -1,4 +1,5 @@
> -<!-- SPDX-License-Identifier: GPL-2.0 -->
> +{# SPDX-License-Identifier: GPL-2.0 #}
> +

So this stuff started with jinja2 comments, but then was changed to HTML
by 4e98799a7021 in 2023.  The problem being addressed there was that
spdxcheck.py doesn't recognize those comments and whines, and it didn't
seem worth fixing at the time.

I was thinking I should just fix spdxcheck.py now and be done with it,
but it seems that 154916f4b59d by Lukas Bulwahn tweaked the script
earlier this year.

...which is a long way of saying: applied, thanks ... :)

jon