lkml.org 
[lkml]   [2019]   [Sep]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [RFC PATCH] tools: Add SPDX license to man pages
Em Fri, 06 Sep 2019 11:12:58 -0700
Joe Perches <joe@perches.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@intel.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

\
 
 \ /
  Last update: 2019-09-06 21:54    [W:0.076 / U:2.056 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site