Skip to content

Let reuse look inside git submodules #118445

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.

Sign up for GitHub

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 10 commits into from
Dec 12, 2023
Merged

Let reuse look inside git submodules #118445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
16768e5
Add the two licences to LICENCES/ that `reuse` reported missing
jonathanpallant Nov 21, 2023
ce0051a
include submodules in the collected license metadata
pietroalbini Mar 13, 2023
d45eac3
Report missing licenses or copyright text.
jonathanpallant Nov 21, 2023
c6eb03b
condense llvm licensing into a single item
jonathanpallant Nov 22, 2023
daf6121
Put copyright on a line by itself.
jonathanpallant Nov 22, 2023
2d1cd45
Fix generate-copyright tool.
jonathanpallant Nov 22, 2023
7a49ac5
Add missing CC-BY-SA-4.0.
jonathanpallant Nov 22, 2023
c1577e5
Update reuse command to include submodules.
jonathanpallant Nov 23, 2023
efa4416
Change LLVM reuse dep5 line to say AND.
jonathanpallant Nov 29, 2023
eba02ab
Reinstate the names of the Ayu dark theme developers.
jonathanpallant Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 37 additions & 11 deletions .reuse/dep5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# WARNING: this metadata is currently incomplete, do not rely on it yet.

Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Files-Excluded:
src/llvm-project

# Note that we're explicitly listing the individual files at the root of the
# repository rather than just having `Files: *`. This is explicitly done to
Expand Down Expand Up @@ -39,13 +37,8 @@ Files: compiler/*
Copyright: The Rust Project Developers (see https://thanks.rust-lang.org)
License: MIT or Apache-2.0

Files: compiler/rustc_codegen_cranelift/src/cranelift_native.rs
Copyright: The Cranelift Project Developers
The Rust Project Developers (see https://thanks.rust-lang.org)
License: Apache-2.0 WITH LLVM-exception AND (Apache-2.0 OR MIT)

Files: compiler/rustc_llvm/llvm-wrapper/SymbolWrapper.cpp
Copyright: LLVM authors
Copyright: 2003-2019 University of Illinois at Urbana-Champaign.
The Rust Project Developers (see https://thanks.rust-lang.org)
License: Apache-2.0 WITH LLVM-exception AND (Apache-2.0 OR MIT)

Expand Down Expand Up @@ -85,11 +78,44 @@ Files: src/librustdoc/html/static/css/normalize.css
Copyright: Nicolas Gallagher and Jonathan Neal
License: MIT

Files: src/librustdoc/html/static/css/themes/ayu.css
Copyright: Ike Ku, Jessica Stokes, Leon Guan
Files: src/librustdoc/html/static/css/rustdoc.css
Copyright: 2016 Ike Ku, Jessica Stokes and Leon Guan
The Rust Project Developers (see https://thanks.rust-lang.org)
License: MIT OR Apache-2.0

Files: src/doc/rustc-dev-guide/mermaid.min.js
Copyright: Knut Sveidqvist
Copyright: 2014-2021 Knut Sveidqvist
License: MIT

Files: library/backtrace/*
Copyright: 2014 Alex Crichton
The Rust Project Developers (see https://thanks.rust-lang.org)
License: MIT OR Apache-2.0

Files: src/doc/embedded-book/*
Copyright: Rust on Embedded Devices Working Group
The Rust Project Developers (see https://thanks.rust-lang.org)
License: MIT OR Apache-2.0 OR CC-BY-SA-4.0

Files: src/doc/rust-by-example/*
Copyright: 2014 Jorge Aparicio
The Rust Project Developers (see https://thanks.rust-lang.org)
License: MIT OR Apache-2.0

# Reuse cannot process the LLVM source tree, and so the copyrights for the LLVM
# submodule are written out here manually. The collect-licence-metadata tool
# has a specific exception coded within it to ignore ./src/llvm-project so
# any time LLVM is updated, please revisit this section. The copyrights are
# taken from the relevant LLVM sub-folders: llvm, lld, lldb, compiler-rt and libunwind.
Comment on lines +108 to +109
Copy link
Member

Choose a reason for hiding this comment

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

It seems likely that we're going to not do this - especially without a clearer story on what "revisit" means.

Can we either remove this ask or try to make it more clear-cut to comply with it? Maybe we should be pushing LLVM upstream to improve metadata tracking of some kind?

Copy link
Contributor Author

@jonathanpallant jonathanpallant Dec 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

LLVM express their copyright through a combination of the CREDITS.txt file, and a collection of files called LICENSE.txt (example) dotted in various subfolders. There's no automated way to grok all that, so I had to do it manually.

The note were was as a reminder that, if someone bumps the LLVM subtree, they have to go and re-read the LICENSE.txt files and see if any of the copyrights have been updated or the LLVM license has changed. For example, as some point the NCSA license will be dropped and it will be Apache-with-exceptions only.

Copy link
Member

Choose a reason for hiding this comment

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

I see. It seems likely that this will not happen on LLVM tree bumps (those are done far too often for someone to do this analysis). That's probably OK; it just means we'll want to eventually schedule some audit of this file (yearly or quaterly perhaps) that goes through and updates this sort of thing.

#
# The git hash for the CREDITS.TXT file is taken from the current git submodule
# commit for ./src/llvm-project.
#
# The copyright years were compiled by looking at all the relevant
# ./src/llvm-project/*/LICENSE.txt files

Files: src/llvm-project/*
Copyright: 2003-2019 by the contributors listed in [CREDITS.TXT](https://github.com/rust-lang/llvm-project/blob/7738295178045041669876bf32b0543ec8319a5c/llvm/CREDITS.TXT)
2010 Apple Inc
2003-2019 University of Illinois at Urbana-Champaign.
License: NCSA AND Apache-2.0 WITH LLVM-exception
319 changes: 319 additions & 0 deletions LICENSES/CC-BY-3.0.txt
View file
Open in desktop

Large diffs are not rendered by default.

Loading