diff mbox series

[RFC] tools: Add SPDX license to man pages

Message ID 1b1cfc9c8c13b58c47d1d123763c8bc412abf9d4.camel@perches.com (mailing list archive)
State New, archived
Headers show
Series [RFC] tools: Add SPDX license to man pages | expand

Commit Message

Joe Perches Sept. 6, 2019, 6:12 p.m. UTC 
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(+)

Comments

Mauro Carvalho Chehab Sept. 6, 2019, 7:53 p.m. UTC | #1 
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
diff mbox series

Patch

diff --git a/tools/power/acpi/man/acpidump.8 b/tools/power/acpi/man/acpidump.8
index 79e2d1d435d1..31513ea4bc6b 100644
--- a/tools/power/acpi/man/acpidump.8
+++ b/tools/power/acpi/man/acpidump.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH ACPIDUMP 8
 .SH NAME
 acpidump \- dump a system's ACPI tables to an ASCII file
diff --git a/tools/power/cpupower/man/cpupower-frequency-info.1 b/tools/power/cpupower/man/cpupower-frequency-info.1
index 6aa8d239dff9..e3f46215c3b6 100644
--- a/tools/power/cpupower/man/cpupower-frequency-info.1
+++ b/tools/power/cpupower/man/cpupower-frequency-info.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH "CPUPOWER\-FREQUENCY\-INFO" "1" "0.1" "" "cpupower Manual"
 .SH "NAME"
 .LP 
diff --git a/tools/power/cpupower/man/cpupower-frequency-set.1 b/tools/power/cpupower/man/cpupower-frequency-set.1
index b50570221a5b..f6b4619e7ef6 100644
--- a/tools/power/cpupower/man/cpupower-frequency-set.1
+++ b/tools/power/cpupower/man/cpupower-frequency-set.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH "CPUPOWER\-FREQUENCY\-SET" "1" "0.1" "" "cpupower Manual"
 .SH "NAME"
 .LP 
diff --git a/tools/power/cpupower/man/cpupower-idle-info.1 b/tools/power/cpupower/man/cpupower-idle-info.1
index 80a1311fa747..d05728573bd9 100644
--- a/tools/power/cpupower/man/cpupower-idle-info.1
+++ b/tools/power/cpupower/man/cpupower-idle-info.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH "CPUPOWER-IDLE-INFO" "1" "0.1" "" "cpupower Manual"
 .SH "NAME"
 .LP
diff --git a/tools/power/cpupower/man/cpupower-idle-set.1 b/tools/power/cpupower/man/cpupower-idle-set.1
index 21916cff7516..746322ea9b3e 100644
--- a/tools/power/cpupower/man/cpupower-idle-set.1
+++ b/tools/power/cpupower/man/cpupower-idle-set.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH "CPUPOWER-IDLE-SET" "1" "0.1" "" "cpupower Manual"
 .SH "NAME"
 .LP
diff --git a/tools/power/cpupower/man/cpupower-info.1 b/tools/power/cpupower/man/cpupower-info.1
index 340bcd0be7de..d77b34bcf1f3 100644
--- a/tools/power/cpupower/man/cpupower-info.1
+++ b/tools/power/cpupower/man/cpupower-info.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH CPUPOWER\-INFO "1" "22/02/2011" "" "cpupower Manual"
 .SH NAME
 cpupower\-info \- Shows processor power related kernel or hardware configurations
diff --git a/tools/power/cpupower/man/cpupower-monitor.1 b/tools/power/cpupower/man/cpupower-monitor.1
index 70a56476f4b0..4027cf424ea0 100644
--- a/tools/power/cpupower/man/cpupower-monitor.1
+++ b/tools/power/cpupower/man/cpupower-monitor.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH CPUPOWER\-MONITOR "1" "22/02/2011" "" "cpupower Manual"
 .SH NAME
 cpupower\-monitor \- Report processor frequency and idle statistics
diff --git a/tools/power/cpupower/man/cpupower-set.1 b/tools/power/cpupower/man/cpupower-set.1
index 2bcc696f4496..77dec3ec4c10 100644
--- a/tools/power/cpupower/man/cpupower-set.1
+++ b/tools/power/cpupower/man/cpupower-set.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH CPUPOWER\-SET "1" "22/02/2011" "" "cpupower Manual"
 .SH NAME
 cpupower\-set \- Set processor power related kernel or hardware configurations
diff --git a/tools/power/cpupower/man/cpupower.1 b/tools/power/cpupower/man/cpupower.1
index baf741d06e82..0a8b08a1fd90 100644
--- a/tools/power/cpupower/man/cpupower.1
+++ b/tools/power/cpupower/man/cpupower.1
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH CPUPOWER "1" "07/03/2011" "" "cpupower Manual"
 .SH NAME
 cpupower \- Shows and sets processor power related values
diff --git a/tools/power/pm-graph/bootgraph.8 b/tools/power/pm-graph/bootgraph.8
index 64d513f80a2a..4a8981356e1a 100644
--- a/tools/power/pm-graph/bootgraph.8
+++ b/tools/power/pm-graph/bootgraph.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH BOOTGRAPH 8
 .SH NAME
 bootgraph \- Kernel boot timing analysis
diff --git a/tools/power/pm-graph/sleepgraph.8 b/tools/power/pm-graph/sleepgraph.8
index 43aee64316df..ce456d1b7da9 100644
--- a/tools/power/pm-graph/sleepgraph.8
+++ b/tools/power/pm-graph/sleepgraph.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH SLEEPGRAPH 8
 .SH NAME
 sleepgraph \- Suspend/Resume timing analysis
diff --git a/tools/power/x86/turbostat/turbostat.8 b/tools/power/x86/turbostat/turbostat.8
index a6db83a88e85..48ac735526df 100644
--- a/tools/power/x86/turbostat/turbostat.8
+++ b/tools/power/x86/turbostat/turbostat.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH TURBOSTAT 8
 .SH NAME
 turbostat \- Report processor frequency and idle statistics
diff --git a/tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8 b/tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8
index 78c6361898b1..e702d2117062 100644
--- a/tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8
+++ b/tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .\"  This page Copyright (C) 2010 - 2015 Len Brown <len.brown@intel.com>
 .\"  Distributed under the GPL, Copyleft 1994.
 .TH X86_ENERGY_PERF_POLICY 8
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
diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
index a6097be25d28..7430d80d5f66 100644
--- a/tools/usb/usbip/doc/usbip.8
+++ b/tools/usb/usbip/doc/usbip.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
 .SH NAME
 usbip \- manage USB/IP devices
diff --git a/tools/usb/usbip/doc/usbipd.8 b/tools/usb/usbip/doc/usbipd.8
index ac4635db3f03..5f2f4e2d0c9b 100644
--- a/tools/usb/usbip/doc/usbipd.8
+++ b/tools/usb/usbip/doc/usbipd.8
@@ -1,3 +1,4 @@ 
+.\" SPDX-License-Identifier: GPL-2.0-only
 .TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
 .SH NAME
 usbipd \- USB/IP server daemon