Skip to content

Fix project/copyright/license headers #9257

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

Merged
merged 5 commits into from
May 17, 2024

Conversation

dhalbert
Copy link
Collaborator

  • Find files that are CircuitPython-specific and change their headers to say they are part of the the CircuitPython project, not the MicroPython project. This helps distinguish upstream files that we use vs. files of our own. This change was discussed with the MicroPython folks. The new language is This file is part of the CircuitPython project: https://circuitpython.org.
  • Change copyright and license lines to be SPDX-compliant. General format tested with reuse lint. There are still many files that are not SPDX-compliant, so we can't run reuse over the whole source tree.
  • Remove in-line MIT license, since the license is now referenced by SPDX. The license can be found in licenses/.
  • Add missing headers to a number of files. This was particularly common in boards/.
  • Add headers to files that were previously completely empty.
  • A few other small cleanups.
  • The casual script I wrote to do this is in tools/circuitpy_header_change.py.
  • This PR addresses primarily C files. There are files in other languages, text files, etc., that deserve these headers but don't yet have them.

I am not expecting the reviewers to go through every file! I will add reviewers after it builds successfully.

Changing header files to #pragma once will be another PR.

@dhalbert dhalbert requested review from tannewt and jepler May 17, 2024 20:31
@tannewt
Copy link
Member

tannewt commented May 17, 2024

Looks like we'd need fsfe/reuse-tool#512 fixed in order to run reuse over our files.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Looks good to me! I looked what files were changed and also at the changing script. We'll likely need to do a subsequent pass as we merge in other PRs.

@dhalbert
Copy link
Collaborator Author

We'll likely need to do a subsequent pass as we merge in other PRs.

I will definitely do that.

Looks like we'd need fsfe/reuse-tool#512 fixed in order to run reuse over our files.

Yup, I first tested by copying files and LICENSES/* into a temp directory and specifying that as --root-dir. Later I did a little more testing (not of the whole tree at all) just by ignoring some of the errors.

@dhalbert dhalbert merged commit 6b80a76 into adafruit:main May 17, 2024
36 checks passed
@dhalbert dhalbert deleted the fix-copyright-license-headers branch May 17, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy