Add SPDX headers #1532
Merged
Add SPDX headers #1532
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicholasbishop
force-pushed
the
bishop-spdx
branch
from
f3fbba4 to
0740712
Compare
nicholasbishop
force-pushed
the
bishop-spdx
branch
from
0740712 to
8cdf08d
Compare
phip1611
reviewed
Feb 7, 2025
xtask/src/main.rs
Outdated
| let paths = std::str::from_utf8(&output.stdout)?.lines(); | ||
|
|
||
| // Path prefixes that should not be checked/formatted. | ||
| let exclude_path_prefixes = [ |
There was a problem hiding this comment.
nit: This could be a more prominent constant
phip1611
reviewed
Feb 7, 2025
xtask/src/main.rs
Outdated
| "uefi-macros/tests/ui/", | ||
| ]; | ||
|
|
||
| let expected_header = "// SPDX-License-Identifier: MIT OR Apache-2.0\n\n"; |
There was a problem hiding this comment.
maybe also make this a constant; close to the new constant mentioned above?
phip1611
reviewed
Feb 7, 2025
| // Paths that are missing the file header (only used in check mode). | ||
| let mut missing = Vec::new(); | ||
|
|
||
| for path in paths { |
There was a problem hiding this comment.
nit: this could be written more nice
paths.into_iter()
.filter(|path| !exclude_path_prefixes.any(|e| e.startsWith(path)))
.filter(|path| {
let text = fs_err::read_to_string(path)?;
!text.startsWith(expected_header)
})
.forEach(|missing| /* ... */)There was a problem hiding this comment.
IMO too much iterator chaining can make things less readable than an imperative loop. I've updated it to move the filtering of excluded paths out of the main loop though, I agree that is little clearer.
phip1611
reviewed
Feb 7, 2025
This will be used to verify that source files (just *.rs for now) all have an SPDX license header. In non-check mode, the license header will be added. For now, in check mode an error is shown but it's not treated as fatal. Once all files have been fixed, the error will be made fatal.
nicholasbishop
force-pushed
the
bishop-spdx
branch
from
8cdf08d to
93062c1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
xtaskcode for checking/adding SPDX headers.uefi-macros,uefi-raw,uefi-test-runner,uefi, andxtaskdirectoriesxtaskheader check fatal if any headers are missing.Closes #1511
Checklist