From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Joe Perches <joe@perches.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Linux Media Mailing List <linux-media@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Jessica Yu <jeyu@kernel.org>,
Federico Vaga <federico.vaga@vaga.pv.it>,
Thomas Gleixner <tglx@linutronix.de>,
linux-doc@vger.kernel.org, Robert Moore <robert.moore@intel.com>,
Erik Schmauss <erik.schmauss@intel.com>,
"Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
Len Brown <lenb@kernel.org>, Thomas Renninger <trenn@suse.com>,
Shuah Khan <shuah@kernel.org>,
Valentina Manea <valentina.manea.m@gmail.com>,
linux-acpi@vger.kernel.org, devel@acpica.org,
linux-pm@vger.kernel.org, linux-usb <linux-usb@vger.kernel.org>
Subject: Re: [RFC PATCH] tools: Add SPDX license to man pages
Date: Fri, 6 Sep 2019 16:53:41 -0300 [thread overview]
Message-ID: <20190906164959.288ab3d5@coco.lan> (raw)
In-Reply-To: <1b1cfc9c8c13b58c47d1d123763c8bc412abf9d4.camel@perches.com>
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
next prev parent reply other threads:[~2019-09-06 19:53 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-31 15:11 [PATCH] media: siano: Use the correct style for SPDX License Identifier Nishad Kamdar
2019-09-04 18:34 ` Mauro Carvalho Chehab
2019-09-04 18:36 ` Greg Kroah-Hartman
2019-09-04 19:00 ` Mauro Carvalho Chehab
2019-09-04 19:26 ` Joe Perches
2019-09-05 5:54 ` Greg Kroah-Hartman
2019-09-05 8:56 ` Mauro Carvalho Chehab
2019-09-05 9:23 ` [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts Mauro Carvalho Chehab
2019-09-05 9:27 ` Greg Kroah-Hartman
2019-09-05 10:50 ` Mauro Carvalho Chehab
2019-09-05 11:01 ` [PATCH 1/3] docs: sphinx: add SPDX header for some sphinx extensions Mauro Carvalho Chehab
2019-09-05 11:01 ` [PATCH 2/3] tools: perf: fix SPDX header in the light of PEP-263 Mauro Carvalho Chehab
2019-09-05 11:01 ` [PATCH 3/3] tools: intel_pstate_tracer.py: " Mauro Carvalho Chehab
2019-09-05 12:07 ` [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts Mauro Carvalho Chehab
2019-09-05 17:45 ` Joe Perches
2019-09-06 11:34 ` Mauro Carvalho Chehab
2019-09-06 11:37 ` Mauro Carvalho Chehab
2019-09-06 12:20 ` Joe Perches
2019-09-06 14:45 ` Mauro Carvalho Chehab
2019-09-06 16:20 ` Joe Perches
2019-09-06 17:33 ` Joe Perches
2019-09-06 18:17 ` Mauro Carvalho Chehab
2019-09-06 18:30 ` Joe Perches
2019-09-06 18:12 ` [RFC PATCH] tools: Add SPDX license to man pages Joe Perches
2019-09-06 19:53 ` Mauro Carvalho Chehab [this message]
2019-09-05 12:57 ` [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts Jonathan Corbet
2019-09-05 14:17 ` Greg Kroah-Hartman
2019-09-05 17:10 ` Mauro Carvalho Chehab
2019-09-06 16:41 ` Markus Heiser
2019-09-05 19:28 ` Mauro Carvalho Chehab
2019-09-05 19:40 ` Jonathan Corbet
2019-09-05 20:07 ` Mauro Carvalho Chehab
2019-09-06 15:18 ` Markus Heiser
2019-09-05 9:28 ` [PATCH] media: siano: Use the correct style for SPDX License Identifier Joe Perches
2019-09-05 10:46 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190906164959.288ab3d5@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=devel@acpica.org \
--cc=erik.schmauss@intel.com \
--cc=federico.vaga@vaga.pv.it \
--cc=gregkh@linuxfoundation.org \
--cc=jeyu@kernel.org \
--cc=joe@perches.com \
--cc=lenb@kernel.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=rafael.j.wysocki@intel.com \
--cc=robert.moore@intel.com \
--cc=shuah@kernel.org \
--cc=tglx@linutronix.de \
--cc=trenn@suse.com \
--cc=valentina.manea.m@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).