Skip to content

Machine-readable license information with REUSE - #1282

Open
Volker-Weissmann wants to merge 2 commits into
madler:developfrom
Volker-Weissmann:develop
Open

Machine-readable license information with REUSE#1282
Volker-Weissmann wants to merge 2 commits into
madler:developfrom
Volker-Weissmann:develop

Conversation

@Volker-Weissmann

Copy link
Copy Markdown

Hello there,
REUSE is a standard that allows a project to specifiy license and copyright information in a machine-readable format (e.g. reuse lint --json now tells you which file has which license).

E.g. the ArchLinux project also likes REUSE.

Happy to hear what you are thinking about this!

@Volker-Weissmann
Volker-Weissmann marked this pull request as draft July 18, 2026 21:28
@Volker-Weissmann

Copy link
Copy Markdown
Author

I just noticed that I need to fix a few things first, so I temporarily converted this PR to a draft...

@Volker-Weissmann

Copy link
Copy Markdown
Author

I did some fixups.

  1. I mostly made the REUSE.toml state what the comments in the source files currently literally state, even if I think the comments are wrong. If you want I can make a seperate PR where I do some minor fixups to these comments.

  2. I could also insert //SPDX-License-Identifier: ... and //SPDX-FileCopyrightText: ... comments into the source files instead of using a REUSE.toml file. Both the REUSE specification and me would actually even prefer this, since in the future people might forgot to need to update REUSE.toml when they e.g. move a file. The disadvantage is that we would have a commit that touches a lot of files. I you want to, I can make a sperate PR.

  3. skipset.h included a comment that says "See MiniZip_info.txt for the license.". "MiniZip_info.txt" does not exist, but "MiniZip64_info.txt" does. The latter states that skipset.h has the same license as the rest of zlib, so I removed the "See MiniZip_info.txt for the license." comment.

@Volker-Weissmann
Volker-Weissmann marked this pull request as ready for review July 30, 2026 13:50
Comment thread contrib/minizip/skipset.h
@@ -1,6 +1,5 @@
/* skipset.h -- set operations using a skiplist
Copyright (C) 2024-2026 Mark Adler
See MiniZip_info.txt for the license.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Removing reference to license location from source file is usually frowned upon under DMCA. Instead path to the license file should be fixed if it has a typo or the license text is currently located in another file.

@mtl1979

mtl1979 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor
  1. I could also insert //SPDX-License-Identifier: ... and //SPDX-FileCopyrightText: ... comments into the source files instead of using a REUSE.toml file. Both the REUSE specification and me would actually even prefer this, since in the future people might forgot to need to update REUSE.toml when they e.g. move a file. The disadvantage is that we would have a commit that touches a lot of files. I you want to, I can make a sperate PR.

PRs with a lot of multi-line changes usually take longer to review, but as long as the changes are isolated to added lines and patch doesn't modify existing lines, it will not grow too long to review. There can be (one) CI run that verify relevant files have valid SPDX identifiers. Tools that require modifying existing lines in a lot of files might need more discussion if the change is warranted.

@Volker-Weissmann

Copy link
Copy Markdown
Author
  1. I could also insert //SPDX-License-Identifier: ... and //SPDX-FileCopyrightText: ... comments into the source files instead of using a REUSE.toml file. Both the REUSE specification and me would actually even prefer this, since in the future people might forgot to need to update REUSE.toml when they e.g. move a file. The disadvantage is that we would have a commit that touches a lot of files. I you want to, I can make a sperate PR.

PRs with a lot of multi-line changes usually take longer to review, but as long as the changes are isolated to added lines and patch doesn't modify existing lines, it will not grow too long to review. There can be (one) CI run that verify relevant files have valid SPDX identifiers. Tools that require modifying existing lines in a lot of files might need more discussion if the change is warranted.

Then I will prepare the PR. (ETA: 2026-11-01)

Comment thread .github/workflows/contribs.yml Outdated
I'm gonna rebase once we are done with the other stuff

Co-authored-by: tbeu <tbeu@users.noreply.github.com>
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.

3 participants