Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simpler License Headers #3489

Merged
merged 17 commits into from
Oct 30, 2019
Merged

Conversation

trexfeathers
Copy link
Contributor

Addresses #3285.

In line with the latest SciTools licensing guidelines, the license headers are much shorter and mostly reference the master file in the root directory.

Also in line with these guidelines, the COPYING.LESSER file has been refactored to be called LICENSE, while COPYING has been removed since it was not being referenced.

The years test in test_coding_standards.py has been replaced with a basic check that each file starts with the correct string.

@trexfeathers
Copy link
Contributor Author

Apologies for the slightly messy commit sequence - was originally just aiming for changing the years

@trexfeathers
Copy link
Contributor Author

trexfeathers commented Oct 25, 2019

Not sure how GitHub should be detecting the license, since LICENSE is supposed to be the name and COPYING.LESSER was an unconventional alternative

@QuLogic
Copy link
Member

QuLogic commented Oct 25, 2019

Also in line with these guidelines, the COPYING.LESSER file has been refactored to be called LICENSE, while COPYING has been removed since it was not being referenced.

This is incorrect. The COPYING.LESSER contains additional permissions of the LGPLv3 wrt to the GPLv3. You still need the COPYING file. It is also just as old a name as LICENSE, so I would not call it unconventional. GitHub detects LGPLv3 because this is the correct name.

@trexfeathers trexfeathers added this to In Progress in Iris v3.0.0 via automation Oct 28, 2019
@trexfeathers trexfeathers added this to the v3.0.0 milestone Oct 28, 2019
@trexfeathers trexfeathers self-assigned this Oct 28, 2019
@trexfeathers trexfeathers moved this from In Progress to Waiting for Review in Iris v3.0.0 Oct 28, 2019
@bjlittle
Copy link
Member

@trexfeathers For some context, see How to use GNU licenses for your own software...

That said, at the moment I'd suggest that COPYING is reinstated as was, along with COPYING.LESSER as was.

When, and if, we move to a BSD 3-Clause New license, then we can remove the COPYING and COPYING.LESSER, and then use the LICENSE file as it's sole replacement.

MANIFEST.in Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -1,19 +1,7 @@
# (C) British Crown Copyright 2010 - 2015, Met Office
# Copyright Iris Contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# Copyright Iris contributors not # Copyright Iris Contributors

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@bjlittle bjlittle moved this from Waiting for Review to In Progress in Iris v3.0.0 Oct 30, 2019
@@ -100,7 +88,7 @@
# define the copyright information for latex builds. Note, for html builds,
# the copyright exists directly inside "_templates/layout.html"
upper_copy_year = datetime.datetime.now().year
copyright = u'British Crown Copyright 2010 - {}, Met Office'.format(upper_copy_year)
copyright = u'Copyright Iris Contributors'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copyright Iris contributors

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
Copyright Iris Contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contributors

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
LICENSE_TEMPLATE = \
"""# Copyright Iris Contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contributors

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@trexfeathers
Copy link
Contributor Author

Thank you @QuLogic and @bjlittle for the information on licensing. My latest changes include reverting what I had done with the license files

@bjlittle bjlittle merged commit 1a882f1 into SciTools:master Oct 30, 2019
Iris v3.0.0 automation moved this from In Progress to Done Oct 30, 2019
@bjlittle
Copy link
Member

@trexfeathers Awesome, many thanks! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Iris v3.0.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants