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

Review LGPL-2.1 license headers #371

Merged
merged 14 commits into from
Oct 9, 2024
Merged

Review LGPL-2.1 license headers #371

merged 14 commits into from
Oct 9, 2024

Conversation

Adrian-Stanea
Copy link
Contributor

@Adrian-Stanea Adrian-Stanea commented Sep 19, 2024

Introduction

This PR standardizes the license headers and fixes version mismatches, ensuring all files use LGPL v2.1 instead of v2 or v3.

To be discussed

  1. These files are currently under the more restrictive ADI-BSD license. They should be reviewed to either replace them with alternatives under a more permissive license or to ensure proper mention of their license in the documentation or project files.
    • include/libm2k/tools/i2c.hpp
    • include/libm2k/tools/spi.hpp
    • include/libm2k/tools/uart.hpp
  2. Consider adding a CI check to ensure that certain files contain the appropriate license headers. The CI check should fail if any files do not follow the established license guidelines.

Note

The following files and directories have been omitted from the reviewed files:

Directories:

  • .git*
  • build
  • CI
  • img
  • results
  • wingetopt

Files:

  • *.png
  • *.rst
  • .gitignore
  • 53-adi-m2k-usb.rules
  • AssemblyInfo.cs.in
  • azure-pipelines.yml
  • Doxyfile.in
  • Doxyfile_API.in
  • README*
  • key.snk
  • libm2k-sharp.dll.config.cmakein
  • libm2k-sharp.pc.cmakein
  • libm2k.i
  • libm2k.pc.cmakein
  • libm2kData.xml
  • requirements.txt
  • version.hpp.cmakein

Copy link
Contributor

@AlexandraTrifan AlexandraTrifan left a comment

Choose a reason for hiding this comment

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

Otherwise looks good.
Let's wait for @adisuciu to take a look at this also.
And for now we'll keep this PR open until we have a clear overview of the tools/i2c spi and uart files you mentioned earlier.

It would indeed be a good idea to add a CI job to run a script and do a minimal checkup of the license header existence and version.

Copy link
Contributor

@AlexandraTrifan AlexandraTrifan left a comment

Choose a reason for hiding this comment

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

later edit: We should not modify the license headers in files from deps/wingetopt

- Standardized the format of license headers, replacing ":" with ";" for uniformity.
- Updated license headers from GPL to LGPL where applicable.

Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
Signed-off-by: Adrian Stanea <Adrian.Stanea@analog.com>
@Adrian-Stanea
Copy link
Contributor Author

later edit: We should not modify the license headers in files from deps/wingetopt

Removed license header from cmake file from tools/deps/wingetopt

@Adrian-Stanea
Copy link
Contributor Author

Replaced ADI-BSD license

@AlexandraTrifan AlexandraTrifan merged commit ed432e2 into main Oct 9, 2024
12 checks passed
@AlexandraTrifan AlexandraTrifan deleted the fix/license-headers branch October 9, 2024 10:06
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