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

Make COPYRIGHT.txt compliant with debian/copyright specification #101713

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

twrightsman
Copy link
Contributor

I want to note as someone helping to maintain the godot package in Debian that it's incredibly awesome and helpful that Godot maintains a Debian-compatible copyright file.

I've made some minor adjustments to conform the file to the specification.

  1. Move the header # comment lines into a proper Comment: field.
  2. Remove ./ prefixes from file paths.
    • From the Files: field specification:

      Patterns match pathnames that start at the root of the source tree. Thus, “Makefile.in” matches only the file at the root of the tree, but “*/Makefile.in” matches at any depth.

  3. Add * glob pattern to end of all directories, to match the files within them.
    • From the Files: field specification:

      This syntax does not distinguish file names from directory names; a trailing slash in a pattern will never match any actual path. A whole directory tree may be selected with a pattern like "foo/*".

@AThousandShips

This comment was marked as resolved.

@AThousandShips AThousandShips changed the title Make COPYRIGHT.txt compliant with specification Make COPYRIGHT.txt compliant with debian/copyright specification Jan 17, 2025
@akien-mga
Copy link
Member

I'm confused as to why this specific specification matters? Where did you find that this file is supposed to follow that?

It's written in that file that it follows Debian's specification for machine-readable copyright information. So this PR is (probably, haven't reviewed yet) correct.

@AThousandShips
Copy link
Member

AThousandShips commented Jan 17, 2025

Thank you! My bad it was right there missed it!

The associated scripts in core handling the copyright files needs to be updated to solve CI

@akien-mga
Copy link
Member

akien-mga commented Jan 17, 2025

The changes look fine but it breaks the build, as we actually parse that file too to generate some headers, and the parser is also not spec compliant (probably doesn't need to be, but it should be adjusted to match the new format).

It's in core/core_builders.py#make_license_header.

@twrightsman
Copy link
Contributor Author

Would you like me to fix the parser as part of this PR?

Copy link
Member

@fire fire left a comment

Choose a reason for hiding this comment

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

I did a small review and didn't see anything wrong. Thanks for also updating the script.

Copy link
Member

@akien-mga akien-mga 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! Could you squash the commits? See PR workflow for instructions.

@akien-mga akien-mga modified the milestones: 4.x, 4.4 Jan 17, 2025
Also fix license header generation by skipping over the new Comment
field in the COPYRIGHT.txt header stanza.
@twrightsman
Copy link
Contributor Author

Could you squash the commits?

Done!

Thanks everyone for reviewing and again for maintaining this copyright file.

@Repiteo Repiteo merged commit aee6f86 into godotengine:master Jan 17, 2025
20 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Jan 17, 2025

Thanks!

@twrightsman twrightsman deleted the fix-copyright branch January 18, 2025 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants