Linux-PM Archive on lore.kernel.org
 help / color / Atom feed
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
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

      reply index

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20190905055614.7958918b@coco.lan>
     [not found] ` <88e638eb959095ab6657d295f9f8c27169569bf2.1567675272.git.mchehab+samsung@kernel.org>
     [not found]   ` <20190905092703.GA30899@kroah.com>
     [not found]     ` <20190905090701.37dcf75e@coco.lan>
     [not found]       ` <b32c2e46b91e7bcda2a9bd140673f06d71b2487a.camel@perches.com>
     [not found]         ` <20190906083457.7e7934ec@coco.lan>
2019-09-06 18:12           ` Joe Perches
2019-09-06 19:53             ` Mauro Carvalho Chehab [this message]

Reply instructions:

You may reply publically 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

Linux-PM Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-pm/0 linux-pm/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-pm linux-pm/ https://lore.kernel.org/linux-pm \
		linux-pm@vger.kernel.org linux-pm@archiver.kernel.org
	public-inbox-index linux-pm

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-pm


AGPL code for this site: git clone https://public-inbox.org/ public-inbox