From: Bruce Richardson <bruce.richardson@intel.com>
To: Hemant Agrawal <hemant.agrawal@nxp.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH 0/5] Use SPDX tags on C files
Date: Wed, 20 Dec 2017 11:16:45 +0000 [thread overview]
Message-ID: <20171220111643.GA4632@bricha3-MOBL3.ger.corp.intel.com> (raw)
In-Reply-To: <20171220100655.GA19304@bricha3-MOBL3.ger.corp.intel.com>
On Wed, Dec 20, 2017 at 10:06:55AM +0000, Bruce Richardson wrote:
> On Wed, Dec 20, 2017 at 12:21:21PM +0530, Hemant Agrawal wrote:
> > On 12/19/2017 8:03 PM, Bruce Richardson wrote:
> > > This contains the output of a script run to replace the BSD License with
> > > SPDX tags on Intel copyright files. The script should only have modified
> > > files with a single, Intel copyright on them, and ignored all files that
> > > had multiple copyright lines. Due to variance in the headers used, not all
> > > files were updated automatically, 11 files were manually done in this set
> > > too. Any others missed can be updated in later sets once found.
> > >
> >
> > SPDX tag is in 2nd line, first line of files is still "/*-" or it's
> > variances.
> >
> > Linux uses the SPDX in the very first line as it will help in checkpatch and
> > other tools.
> >
> > The proposed licenses/README states:
> > "DPDK uses first line of the file to be SPDX tag. In case of *#!* scripts,
> > SPDX tag can be placed in 2nd line of the file.
> >
>
> So what is the expected format for these headers - using "//" or "/* */"
> for the first-line tag? What about for the copyright lines?
>
> If we want the SPDX identifier as the first line we have a number of
> options, and we should settle on one. Here are the options I see:
> [1]
> /* SPDX-License-Identifier: BSD-3-Clause
> * Copyright(c) 2010-2014 Intel Corporation
> */
>
> Which can work, if you don't mind the unbalanced /* vs */ inline vs
> separate line.
>
> Alternatively, we can use // for some or all of the tag and copyright:
> [2]
> // SPDX-License-Identifier: BSD-3-Clause
> // Copyright(c) 2010-2014 Intel Corporation
>
> or
> [3]
> // SPDX-License-Identifier: BSD-3-Clause
> /* Copyright(c) 2010-2014 Intel Corporation
> */
>
> [For the latter, I think the close */ should be on a newline to look ok
> in the case of multiple copyrights, and an "All rights reserved" line if
> present]
>
> Finally, I suppose there is the (ugly IMHO) option of:
> [4]
> // SPDX-License-Identifier: BSD-3-Clause
> /*
> * Copyright(c) 2010-2014 Intel Corporation
> */
>
> Any other options?
>
> My preference, given that we only use /* */ style comments in DPDK is
> option 1. If we don't use that, I think option 3 is next best, then 2.
> I notice from the dpaa2 code update patch [pw 32407], you have taken a
> similar approach to option 1 (just with an extra blank line, which is
> fine)
>
> Any other opinions or comments? Anyone disagree with using option #1
> above, and as done by Hemant in his set?
>
Since my preferred option and Hemant's seem to align, I'm going to do a
V2 based on that. If anyone has strong objections to this approach,
please shout them out, otherwise I want to keep this effort moving while
it has momentum.
Thanks,
/Bruce
next prev parent reply other threads:[~2017-12-20 11:16 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-19 14:33 Bruce Richardson
2017-12-19 14:33 ` [dpdk-dev] [PATCH 1/5] app: use SPDX tags for Intel copyright files Bruce Richardson
2017-12-19 14:33 ` [dpdk-dev] [PATCH 2/5] drivers: " Bruce Richardson
2017-12-19 14:33 ` [dpdk-dev] [PATCH 3/5] examples: " Bruce Richardson
2017-12-19 14:33 ` [dpdk-dev] [PATCH 4/5] lib: " Bruce Richardson
2017-12-19 14:33 ` [dpdk-dev] [PATCH 5/5] test: " Bruce Richardson
2017-12-20 6:51 ` [dpdk-dev] [PATCH 0/5] Use SPDX tags on C files Hemant Agrawal
2017-12-20 10:06 ` Bruce Richardson
2017-12-20 11:16 ` Bruce Richardson [this message]
2017-12-20 11:21 ` [dpdk-dev] [PATCH v2 " Bruce Richardson
2017-12-20 11:21 ` [dpdk-dev] [PATCH v2 1/5] app: use SPDX tags for Intel copyright files Bruce Richardson
2017-12-20 11:21 ` [dpdk-dev] [PATCH v2 2/5] drivers: " Bruce Richardson
2017-12-20 11:21 ` [dpdk-dev] [PATCH v2 3/5] examples: " Bruce Richardson
2017-12-20 11:21 ` [dpdk-dev] [PATCH v2 4/5] lib: " Bruce Richardson
2017-12-20 11:22 ` [dpdk-dev] [PATCH v2 5/5] test: " Bruce Richardson
2018-01-04 21:14 ` [dpdk-dev] [PATCH v2 0/5] Use SPDX tags on C files Thomas Monjalon
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=20171220111643.GA4632@bricha3-MOBL3.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=hemant.agrawal@nxp.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).