linux-kernel - Re: [RFC PATCH] tools: Add SPDX license to man pages

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Date:   Fri, 6 Sep 2019 16:53:41 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Joe Perches <joe@...ches.com>
Cc:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Linux Media Mailing List <linux-media@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Jessica Yu <jeyu@...nel.org>,
        Federico Vaga <federico.vaga@...a.pv.it>,
        Thomas Gleixner <tglx@...utronix.de>,
        linux-doc@...r.kernel.org, Robert Moore <robert.moore@...el.com>,
        Erik Schmauss <erik.schmauss@...el.com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Len Brown <lenb@...nel.org>, Thomas Renninger <trenn@...e.com>,
        Shuah Khan <shuah@...nel.org>,
        Valentina Manea <valentina.manea.m@...il.com>,
        linux-acpi@...r.kernel.org, devel@...ica.org,
        linux-pm@...r.kernel.org, linux-usb <linux-usb@...r.kernel.org>
Subject: Re: [RFC PATCH] tools: Add SPDX license to man pages

Em Fri, 06 Sep 2019 11:12:58 -0700
Joe Perches <joe@...ches.com> escreveu:

> On Fri, 2019-09-06 at 08:34 -0300, Mauro Carvalho Chehab wrote:
> > Warning: SPDX header for file tools/thermal/tmon/tmon.8 is at line 2  
> []
> > The last one is interesting... what's the "very first line" where a
> > SPDX header tag should be on a man page?  
> 
> just fyi:
> 
> It looks like .man pages could use a comment form
> using '.\"' like this example on the first line:
> 
> $ head -5 tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8
> .\"  This page Copyright (C) 2010 - 2015 Len Brown <len.brown@...el.com>
> .\"  Distributed under the GPL, Copyleft 1994.
> .TH X86_ENERGY_PERF_POLICY 8
> .SH NAME
> x86_energy_perf_policy \- Manage Energy vs. Performance Policy via x86 Model Specific Registers
> 
> So maybe:
> ---
>  tools/power/acpi/man/acpidump.8                                 | 1 +
>  tools/power/cpupower/man/cpupower-frequency-info.1              | 1 +
>  tools/power/cpupower/man/cpupower-frequency-set.1               | 1 +
>  tools/power/cpupower/man/cpupower-idle-info.1                   | 1 +
>  tools/power/cpupower/man/cpupower-idle-set.1                    | 1 +
>  tools/power/cpupower/man/cpupower-info.1                        | 1 +
>  tools/power/cpupower/man/cpupower-monitor.1                     | 1 +
>  tools/power/cpupower/man/cpupower-set.1                         | 1 +
>  tools/power/cpupower/man/cpupower.1                             | 1 +
>  tools/power/pm-graph/bootgraph.8                                | 1 +
>  tools/power/pm-graph/sleepgraph.8                               | 1 +
>  tools/power/x86/turbostat/turbostat.8                           | 1 +
>  tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8 | 1 +
>  tools/thermal/tmon/tmon.8                                       | 1 +
>  tools/usb/usbip/doc/usbip.8                                     | 1 +
>  tools/usb/usbip/doc/usbipd.8                                    | 1 +
>  16 files changed, 16 insertions(+)

Makes sense. I would also patch license-rules.txt with something like:

diff --git a/Documentation/process/license-rules.rst b/Documentation/process/license-rules.rst
index 5d23e3498b1c..6224421ee120 100644
--- a/Documentation/process/license-rules.rst
+++ b/Documentation/process/license-rules.rst
@@ -76,12 +76,13 @@ License identifier syntax
    The SPDX license identifier is added in form of a comment.  The comment
    style depends on the file type::
 
-      C source:	// SPDX-License-Identifier: <SPDX License Expression>
-      C header:	/* SPDX-License-Identifier: <SPDX License Expression> */
-      ASM:	/* SPDX-License-Identifier: <SPDX License Expression> */
-      scripts:	# SPDX-License-Identifier: <SPDX License Expression>
-      .rst:	.. SPDX-License-Identifier: <SPDX License Expression>
-      .dts{i}:	// SPDX-License-Identifier: <SPDX License Expression>
+      C source:  // SPDX-License-Identifier: <SPDX License Expression>
+      C header:  /* SPDX-License-Identifier: <SPDX License Expression> */
+      ASM:       /* SPDX-License-Identifier: <SPDX License Expression> */
+      scripts:   # SPDX-License-Identifier: <SPDX License Expression>
+      .rst:      .. SPDX-License-Identifier: <SPDX License Expression>
+      .dts{i}:	  // SPDX-License-Identifier: <SPDX License Expression>
+      man pages: .\" SPDX-License-Identifier: <SPDX License Expression>
 
    If a specific tool cannot handle the standard comment style, then the
    appropriate comment mechanism which the tool accepts shall be used. This

> diff --git a/tools/thermal/tmon/tmon.8 b/tools/thermal/tmon/tmon.8
> index 2f122de5841b..cffaa0d65478 100644
> --- a/tools/thermal/tmon/tmon.8
> +++ b/tools/thermal/tmon/tmon.8
> @@ -1,3 +1,4 @@
> +.\" SPDX-License-Identifier: GPL-2.0-only
>  .TH TMON 8
>  # SPDX-License-Identifier: GPL-2.0
>  .SH NAME

Hmm... here, you should probably keep the same license as defined at
the existing tag (GPL-2.0) and remove the comment one.


Thanks,
Mauro