Bug 548298 - JGit's EDL copyright headers
Summary: JGit's EDL copyright headers
Status: RESOLVED FIXED
Alias: None
Product: JGit
Classification: Technology
Component: JGit (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 5.7   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-06-15 06:39 EDT by Matthias Sohn CLA
Modified: 2020-01-05 15:01 EST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Matthias Sohn CLA 2019-06-15 06:39:34 EDT
Some questions regarding copyright headers used in JGit came up in the review [1].

Basically we are wondering
* if we can add a SPDX header
* if this SPDX header should be BSD-3-Clause ([2] links to [3] which says its SPDX identifier is BSD-3-Clause) or does EDL have its own identifier
* if we can shorten the EDL copyright header from the full license text copied into every source file to a form similar to the EPL 2.0 license header which instead of being a verbatim copy of the full text links to the full license text. This would shrink the size of this header from 41 to 9 lines (if there is one Copyright line and the optional Contributors section is omitted)

So effectively could we move to a license header like this (see [4]):

/********************************************************************************
 * Copyright (c) {year} {owner}[ and others]
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License 1.0 which is available at
 * https://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Contributors:
 *   {name} - initial API and implementation
 ********************************************************************************/

[1] https://git.eclipse.org/r/#/c/140618/2..4/org.eclipse.jgit.test/tst/org/eclipse/jgit/revwalk/DepthWalkTopoSortGeneratorTest.java
[2] https://www.eclipse.org/org/documents/edl-v10.php
[3] https://opensource.org/licenses/BSD-3-Clause
[4] https://www.eclipse.org/projects/handbook/#ip-copyright-headers
Comment 1 Matthias Sohn CLA 2019-06-15 06:54:35 EDT
EDL is not listed in the SPDX license list [1], the license text for SPDX BSD-3-Clause is here [2] and seems very close to the EDL license text.

[1] https://spdx.org/licenses/
[2] https://spdx.org/licenses/BSD-3-Clause.html
Comment 2 Matthias Sohn CLA 2019-06-15 07:42:09 EDT
Also see reuse.software by FSFE [1] and the tools it provides to automate usage of SPDX. It does not recognise the license headers used in JGit since there is no SPDX identifier defined for this variant of the BSD-3-Clause license.

Using a tool like this would help a lot to make license headers correct and ensure they are machine readable

[1] https://reuse.software/
Comment 3 Sharon Corbett CLA 2019-06-17 13:21:15 EDT
Hi Matthias:

Please see our legal doc generator for JGit [1].

I believe that does the trick.

Thanks for reaching out.

Best Regards,
Sharon


[1] https://www.eclipse.org/projects/tools/documentation.php?id=technology.jgit
Comment 4 Eclipse Genie CLA 2020-01-03 19:07:09 EST
New Gerrit change created: https://git.eclipse.org/r/155190
Comment 5 Eclipse Genie CLA 2020-01-03 20:54:43 EST
Gerrit change https://git.eclipse.org/r/155190 was merged to [master].
Commit: http://git.eclipse.org/c/jgit/jgit.git/commit/?id=5c5f7c6b146b24f2bd4afae1902df85ad6e57ea3
Comment 6 Matthias Sohn CLA 2020-01-05 15:01:08 EST
changed JGit's license headers to the short, SPDX-compliant format