Skip to content

Commit a4862c9

Browse files
hemantagrtmonjalo
authored andcommitted
license: introduce SPDX identifiers
The DPDK uses the Open Source BSD-3-Clause license for the core libraries and drivers. The kernel components are naturally GPLv2 licensed. Many of the files in the DPDK source code contain the full text of the applicable license. For example, most of the BSD-3-Clause files contain a full copy of the BSD-3-Clause license text. Including big blocks of License headers in all files blows up the source code with mostly redundant information. An additional problem is that even the same licenses are referred to by a number of slightly varying text blocks (full, abbreviated, different indentation, line wrapping and/or white space, with obsolete address information, ...) which makes validation and automatic processing a nightmare. To make this easier, DPDK uses of a single line reference to Unique License Identifiers in source files as defined by the Linux Foundation's SPDX project https://spdk.org. Adding license information in this fashion, rather than adding full license text, can be more efficient for developers; decreases errors; and improves automated detection of licenses. The current set of valid, predefined SPDX identifiers is set forth on the SPDX License List at https://spdx.org/licenses/. For example, to label a file as subject to the BSD-3-Clause license, the following text would be used as the top line of the file. SPDX-License-Identifier: BSD-3-Clause Note: Any new file contributions in DPDK shall adhere to the above scheme. It is also recommended to replace or at least amend the existing license text in the code with SPDX-License-Identifiers. Any exception to DPDK IP policies shall be approved by DPDK tech board and DPDK Governing Board. Steps for any exception approval: 1. Mention the appropriate license identifier form SPDX. If the license is not listed in SPDX Licenses. It is the submitters responsibiliity to get it first listed. 2. Get the required approval from the DPDK Technical Board. Technical board may advise the author to check alternate means first. If no other alternatives are found and the merit of the contributions are important for DPDK's mission, it may decide on such exception with two-thirds vote of the members. 3. Technical board then approach Governing board for such limited approval for the given contribution only. Any approvals shall be documented in "licenses/exceptions.txt" with record dates. Note: From the legal point of view, this patch is supposed to be only a change to the textual representation of the license information, but in no way any change to the actual license terms. With this patch applied, all files will still be licensed under the same terms they were before. Signed-off-by: Hemant Agrawal <[email protected]> Acked-by: Stephen Hemminger <[email protected]> Acked-by: Thomas Monjalon <[email protected]>
1 parent cb9c546 commit a4862c9

File tree

8 files changed

+146
-18
lines changed

8 files changed

+146
-18
lines changed

MAINTAINERS

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ F: devtools/get-maintainer.sh
5252
F: devtools/git-log-fixes.sh
5353
F: devtools/load-devel-config
5454
F: devtools/test-build.sh
55+
F: license/
5556

5657

5758
Build System

README

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
DPDK is a set of libraries and drivers for fast packet processing.
22
It supports many processor architectures and both FreeBSD and Linux.
33

4-
The DPDK uses the Open Source BSD license for the core libraries and
5-
drivers. The kernel components are GPLv2 licensed.
4+
The DPDK uses the Open Source BSD-3-Clause license for the core libraries
5+
and drivers. The kernel components are GPL-2.0 licensed.
66

77
Please check the doc directory for release notes,
88
API documentation, and sample application information.

doc/guides/contributing/patches.rst

+23
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,29 @@ It is also worth registering for the DPDK `Patchwork <http://dpdk.org/dev/patchw
3232
The development process requires some familiarity with the ``git`` version control system.
3333
Refer to the `Pro Git Book <http://www.git-scm.com/book/>`_ for further information.
3434

35+
Source License
36+
--------------
37+
38+
The DPDK uses the Open Source BSD-3-Clause license for the core libraries and
39+
drivers. The kernel components are GPL-2.0 licensed. DPDK uses single line
40+
reference to Unique License Identifiers in source files as defined by the Linux
41+
Foundation's `SPDX project <http://spdx.org/>`_.
42+
43+
DPDK uses first line of the file to be SPDX tag. In case of *#!* scripts, SPDX
44+
tag can be placed in 2nd line of the file.
45+
46+
For example, to label a file as subject to the BSD-3-Clause license,
47+
the following text would be used:
48+
49+
``SPDX-License-Identifier: BSD-3-Clause``
50+
51+
To label a file as dual-licensed with BSD-3-Clause and GPL-2.0 (e.g., for code
52+
that is shared between the kernel and userspace), the following text would be
53+
used:
54+
55+
``SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)``
56+
57+
Refer to ``licenses/README`` for more details.
3558

3659
Maintainers and Sub-trees
3760
-------------------------

license/README

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
The DPDK uses the Open Source BSD-3-Clause license for the core libraries and
2+
drivers. The kernel components are naturally GPL-2.0 licensed.
3+
4+
Including big blocks of License headers in all files blows up the
5+
source code with mostly redundant information. An additional problem
6+
is that even the same licenses are referred to by a number of
7+
slightly varying text blocks (full, abbreviated, different
8+
indentation, line wrapping and/or white space, with obsolete address
9+
information, ...) which makes validation and automatic processing a nightmare.
10+
11+
To make this easier, DPDK uses a single line reference to Unique License
12+
Identifiers in source files as defined by the Linux Foundation's SPDX project
13+
(https://spdx.org/).
14+
15+
Adding license information in this fashion, rather than adding full license
16+
text, can be more efficient for developers; decreases errors; and improves
17+
automated detection of licenses. The current set of valid, predefined SPDX
18+
identifiers is set forth on the SPDX License List at https://spdx.org/licenses/.
19+
20+
DPDK uses first line of the file to be SPDX tag. In case of *#!* scripts, SPDX
21+
tag can be placed in 2nd line of the file.
22+
23+
For example, to label a file as subject to the BSD-3-Clause license,
24+
the following text would be used:
25+
26+
SPDX-License-Identifier: BSD-3-Clause
27+
28+
To label a file as GPL-2.0 (e.g., for code that runs in the kernel), the
29+
following text would be used:
30+
31+
SPDX-License-Identifier: GPL-2.0
32+
33+
To label a file as dual-licensed with BSD-3-Clause and GPL-2.0 (e.g., for code
34+
that is shared between the kernel and userspace), the following text would be
35+
used:
36+
37+
SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
38+
39+
To label a file as dual-licensed with BSD-3-Clause and LGPL-2.1 (e.g., for code
40+
that is shared between the kernel and userspace), the following text would be
41+
used:
42+
43+
SPDX-License-Identifier: (BSD-3-Clause OR LGPL-2.1)
44+
45+
Any new file contributions in DPDK shall adhere to the above scheme.
46+
It is also being recommended to replace the existing license text in the code
47+
with SPDX-License-Identifiers.
48+
49+
Any exception to the DPDK IP policies shall be approved by DPDK Tech Board and
50+
DPDK Governing Board. Steps for any exception approval:
51+
1. Mention the appropriate license identifier form SPDX. If the license is not
52+
listed in SPDX Licenses. It is the submitters responsibiliity to get it
53+
first listed.
54+
2. Get the required approval from the DPDK Technical Board. Technical Board may
55+
advise the author to check alternate means first. If no other alternative
56+
are found and the merit of the contributions are important for DPDK's
57+
mission, it may decide on such exception with two-thirds vote of the members.
58+
3. Technical Board then approach Governing Board for such limited approval for
59+
the given contribution only.
60+
61+
Any approvals shall be documented in "Licenses/exceptions.txt" with record
62+
dates.
63+
64+
DPDK project supported licenses are:
65+
66+
1. BSD 3-clause "New" or "Revised" License
67+
SPDX-License-Identifier: BSD-3-Clause
68+
URL: http://spdx.org/licenses/BSD-3-Clause#licenseText
69+
DPDK License text: licenses/bsd-3-clause.txt
70+
2. GNU General Public License v2.0 only
71+
SPDX-License-Identifier: GPL-2.0
72+
URL: http://spdx.org/licenses/GPL-2.0.html#licenseText
73+
DPDK License text: licenses/gpl-2.0.txt
74+
3. GNU Lesser General Public License v2.1
75+
SPDX-License-Identifieri: LGPL-2.1
76+
URL: http://spdx.org/licenses/LGPL-2.1.html#licenseText
77+
DPDK License text: licenses/lgpl-2.1.txt

license/bsd-3-clause.txt

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
2+
3+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
4+
5+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
6+
7+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
8+
9+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

license/exceptions.txt

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
This file will record any exceptions in DPDK Project with respect to DPDK
2+
IP License policy as defined in DPDK Charter available at:
3+
4+
http://dpdk.org/about/charter#ip
5+
6+
Note that following licenses are not exceptions:-
7+
- BSD-3-Clause
8+
- Dual BSD-3-Clause OR GPL-2.0
9+
- Dual BSD-3-Clause OR LGPL-2.1
10+
- GPL-2.0 (*Only for kernel code*)
11+
12+
-----------------------------------------------------------------
13+
SPDX Identifier TB Approval Date GB Approval Date File name
14+
-----------------------------------------------------------------
15+
1.
16+
17+
-----------------------------------------------------------------
18+

LICENSE.GPL license/gpl-2.0.txt

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
GNU GENERAL PUBLIC LICENSE
2-
Version 2, June 1991
1+
GNU GENERAL PUBLIC LICENSE
2+
Version 2, June 1991
33

44
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
55
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
66
Everyone is permitted to copy and distribute verbatim copies
77
of this license document, but changing it is not allowed.
88

9-
Preamble
9+
Preamble
1010

1111
The licenses for most software are designed to take away your
1212
freedom to share and change it. By contrast, the GNU General Public
@@ -56,7 +56,7 @@ patent must be licensed for everyone's free use or not licensed at all.
5656
The precise terms and conditions for copying, distribution and
5757
modification follow.
5858

59-
GNU GENERAL PUBLIC LICENSE
59+
GNU GENERAL PUBLIC LICENSE
6060
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
6161

6262
0. This License applies to any program or other work which contains
@@ -255,7 +255,7 @@ make exceptions for this. Our decision will be guided by the two goals
255255
of preserving the free status of all derivatives of our free software and
256256
of promoting the sharing and reuse of software generally.
257257

258-
NO WARRANTY
258+
NO WARRANTY
259259

260260
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261261
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
@@ -277,9 +277,9 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277277
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278278
POSSIBILITY OF SUCH DAMAGES.
279279

280-
END OF TERMS AND CONDITIONS
280+
END OF TERMS AND CONDITIONS
281281

282-
How to Apply These Terms to Your New Programs
282+
How to Apply These Terms to Your New Programs
283283

284284
If you develop a new program, and you want it to be of the greatest
285285
possible use to the public, the best way to achieve this is to make it

LICENSE.LGPL license/lgpl-2.1.txt

+9-9
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ modified by someone else and passed on, the recipients should know
5555
that what they have is not the original version, so that the original
5656
author's reputation will not be affected by problems that might be
5757
introduced by others.
58-
58+
5959
Finally, software patents pose a constant threat to the existence of
6060
any free program. We wish to make sure that a company cannot
6161
effectively restrict the users of a free program by obtaining a
@@ -111,7 +111,7 @@ modification follow. Pay close attention to the difference between a
111111
"work based on the library" and a "work that uses the library". The
112112
former contains code derived from the library, whereas the latter must
113113
be combined with the library in order to run.
114-
114+
115115
GNU LESSER GENERAL PUBLIC LICENSE
116116
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117117

@@ -158,7 +158,7 @@ Library.
158158
You may charge a fee for the physical act of transferring a copy,
159159
and you may at your option offer warranty protection in exchange for a
160160
fee.
161-
161+
162162
2. You may modify your copy or copies of the Library or any portion
163163
of it, thus forming a work based on the Library, and copy and
164164
distribute such modifications or work under the terms of Section 1
@@ -216,7 +216,7 @@ instead of to this License. (If a newer version than version 2 of the
216216
ordinary GNU General Public License has appeared, then you can specify
217217
that version instead if you wish.) Do not make any other change in
218218
these notices.
219-
219+
220220
Once this change is made in a given copy, it is irreversible for
221221
that copy, so the ordinary GNU General Public License applies to all
222222
subsequent copies and derivative works made from that copy.
@@ -267,7 +267,7 @@ Library will still fall under Section 6.)
267267
distribute the object code for the work under the terms of Section 6.
268268
Any executables containing that work also fall under Section 6,
269269
whether or not they are linked directly with the Library itself.
270-
270+
271271
6. As an exception to the Sections above, you may also combine or
272272
link a "work that uses the Library" with the Library to produce a
273273
work containing portions of the Library, and distribute that work
@@ -329,7 +329,7 @@ restrictions of other proprietary libraries that do not normally
329329
accompany the operating system. Such a contradiction means you cannot
330330
use both them and the Library together in an executable that you
331331
distribute.
332-
332+
333333
7. You may place library facilities that are a work based on the
334334
Library side-by-side in a single library together with other library
335335
facilities not covered by this License, and distribute such a combined
@@ -370,7 +370,7 @@ subject to these terms and conditions. You may not impose any further
370370
restrictions on the recipients' exercise of the rights granted herein.
371371
You are not responsible for enforcing compliance by third parties with
372372
this License.
373-
373+
374374
11. If, as a consequence of a court judgment or allegation of patent
375375
infringement or for any other reason (not limited to patent issues),
376376
conditions are imposed on you (whether by court order, agreement or
@@ -422,7 +422,7 @@ conditions either of that version or of any later version published by
422422
the Free Software Foundation. If the Library does not specify a
423423
license version number, you may choose any version ever published by
424424
the Free Software Foundation.
425-
425+
426426
14. If you wish to incorporate parts of the Library into other free
427427
programs whose distribution conditions are incompatible with these,
428428
write to the author to ask for permission. For software which is
@@ -456,7 +456,7 @@ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456456
DAMAGES.
457457

458458
END OF TERMS AND CONDITIONS
459-
459+
460460
How to Apply These Terms to Your New Libraries
461461

462462
If you develop a new library, and you want it to be of the greatest

0 commit comments

Comments
 (0)