This repository was archived by the owner on May 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 18
Prepare 3.2 version of specification #133
Merged
Merged
Changes from all commits
Commits
Show all changes
55 commits
Select commit
Hold shift + click to select a range
d3e4bc1
Bump to 3.2
carmenbianca 8f7fa84
Add Snippet as defined term
carmenbianca e7e6051
Reformat section
carmenbianca 4741404
Improve wording of paragraph
carmenbianca d547fb0
Improve definition of Copyright Notices
carmenbianca 2993608
Spelling
carmenbianca 9f9ebbf
Improve order of precedence
carmenbianca 0426d6c
Yank 3.1 in change log
carmenbianca 779c2f7
Adjust and add change log entries
carmenbianca 5cfce12
Improve Snippet section
carmenbianca 26018ff
Add 'Contributors to project' as example
carmenbianca 19aa3a1
Add REUSE.toml
carmenbianca 363300a
Ignore COPYING and LICENSE
carmenbianca f1fffdb
Remove unneeded capital letter
carmenbianca ffadfd5
Add extra example
carmenbianca 327414a
Clarify override of `.license` files
carmenbianca 27f1b16
Reword comment headers to correctly use MUST
carmenbianca f5cb72d
Remove a superfluous text now that snippets exist
carmenbianca a5675b1
Added hyperlink to Format of Copyright Notices section
carmenbianca 0132b66
Move ignore block to own section
carmenbianca f7035cb
Improve the wording for the precedence algorithms
carmenbianca 541c026
Add a missing word
carmenbianca 8a45ad4
Make copyright and licensing keys optional in toml
carmenbianca dd8acc2
Clarify glob matches
carmenbianca 0dc31da
REUSE.toml and DEP5 are mutually exclusive
carmenbianca 895e3a9
Do not match base name
carmenbianca c239896
Backticks around REUSE.toml
carmenbianca 3e840f7
Reword path key
carmenbianca 8869ee1
Rename toml precedence type to override
carmenbianca 3fd4eec
COPYING and LICENSE can take file extensions
carmenbianca e6af184
Update change log
carmenbianca ce294f2
Small fixes
carmenbianca ce8b980
Remove empty lines in change log
carmenbianca 1952f88
Make snippets and ignore block sections subsections of comment header
carmenbianca 25e6376
Improve DEP5 example to match REUSE.toml example
carmenbianca 88b37eb
Add 'comprehensive' goal to introduction blurb
carmenbianca 00e6295
More accurate description of glob matching
carmenbianca 70995dd
Add unreleased section to change log
carmenbianca ce8588d
Move deprecation notice to its own section in change log
carmenbianca b0ee22a
Clarify COPYING and LICENSE inclusion
carmenbianca dc41318
Specify that non-license files cannot be in LICENSES/
carmenbianca ce4c36a
Replace NGO with Organisation
carmenbianca 16f0b6e
Easier language for Snippets
carmenbianca 7eefa3c
Recommend comment header above all others
carmenbianca 21dd034
Allow user to include other keys and tables in TOML
carmenbianca 9496bdd
Be more explicit about path separators
carmenbianca 1a36bd0
Be more explicit about DEP5 deprecation
carmenbianca 2be6315
Fix John's e-mail
carmenbianca 2f73815
Simplify globbing
carmenbianca 3f8ea8f
Reduce spacing between list elements
carmenbianca 4e15864
Replace Copyright and Licensing Information with Licensing Information
carmenbianca 738c41b
Add clearer (but tautological) information
carmenbianca 5e6e482
Define TOML in spec
carmenbianca 7bddcad
More explicitly state that REUSE.toml only covers its own directory
carmenbianca 72aa8a8
Explicitly mention `.license` files
carmenbianca File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,58 +20,66 @@ following sections: | |
|
|
||
| The versions follow [semantic versioning](https://semver.org). | ||
|
|
||
| <!-- | ||
| ## Unreleased - YYYY-MM-DD | ||
|
|
||
| ### Added | ||
|
|
||
| ### Changed | ||
|
|
||
| ### Deprecated | ||
|
|
||
| ### Removed | ||
|
|
||
| ### Fixed | ||
|
|
||
| ### Security | ||
| ### Added | ||
| --> | ||
|
|
||
| ## 3.1 - 2023-06-21 | ||
| ## 3.2 - YYYY-MM-DD | ||
|
|
||
| ### Added | ||
|
|
||
| - Definition for Commentable and Uncommentable Files. (#123, thanks @Jayman2000) | ||
|
|
||
| - Introduce support of in-line snippet comments using | ||
| `SPDX-SnippetBegin`/`SPDX-SnippetEnd`. (#107) | ||
|
|
||
| - Specify encoding of `.license` files to UTF-8. (#106, thanks @kirelagin for | ||
| the helpful background information) | ||
|
|
||
| - Introduce `REUSE-IgnoreStart`/`REUSE-IgnoreEnd` to make the REUSE helper tool | ||
| not consider the enclosed content for detecting copyright and licensing | ||
| information. (#104) | ||
|
|
||
| - Definition for Covered File and clarify for which file copyright and licensing | ||
| information is required. (#85, thanks @Jayman2000) | ||
|
|
||
| - Remove SPDX documents from list of Covered Files. (#103) | ||
|
|
||
| - Remove symlinks and zero-byte files from list of Covered Files. (#101) | ||
|
|
||
| - Remove submodules and Meson subprojects from list of Covered Files. (#99) | ||
|
|
||
| - Clarify which license text files are needed if a SPDX license expression | ||
| contains more than one license and/or exception. (#96) | ||
|
|
||
| - URLs to currently applicable SPDX specification. (#49) | ||
| - Define an order or precedence. (formerly #131, overhauled in #133) | ||
| - REUSE.toml definition added. (#133) | ||
|
|
||
| - Define current order or precedence. (#131) | ||
|
|
||
| ### Changed | ||
|
|
||
| - Allow `.license` files for commentable files, but strongly recommend adding | ||
| copyright/licensing information in header. (#123, thanks @Jayman2000) | ||
|
|
||
| - Bump referenced SPDX version to 2.3, and update links. (#103) (#107) | ||
|
|
||
| ### Deprecated | ||
|
|
||
| - DEP5 deprecated. (#133) | ||
carmenbianca marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Fixed | ||
|
|
||
| - Minor typos and grammar mistakes. Thanks @jlovejoy and @Jayman2000! | ||
| - Improved definition of Copyright Notices. (#133) | ||
| - `COPYING` and `LICENSE` are now marked as ignored, when they were already | ||
| ignored by the tool since its inception. (#133) | ||
|
|
||
| ## 3.1 - 2023-06-21 [YANKED] | ||
|
|
||
| This version was yanked soon after release after a new definition of the order | ||
| of precedence broke compatibility. | ||
|
|
||
| ## 3.0 - 2019-08-07 | ||
|
|
||
|
|
@@ -80,15 +88,12 @@ The versions follow [semantic versioning](https://semver.org). | |
| - `SPDX-FileCopyrightText: Jane Doe` is now the recommended way to mark a copyright | ||
| notice instead of `Copyright (C) Jane Doe`. `Copyright` and `©` are still | ||
| supported as prefixes. | ||
|
|
||
| - The specification now makes a recommendation on the format of copyright | ||
| notices, but does not mandate anything other than that the copyright notice | ||
| contain the name of the copyright holder. The format is roughly: | ||
| `SPDX-FileCopyrightText: 2019 Jane Doe <[email protected]>` | ||
|
|
||
| - An FAQ and much-needed tutorial are added to help people along, instead of | ||
| letting the specification do double duty as a tutorial. | ||
|
|
||
| - The tool has been updated to be a lot friendlier to use, and to print more | ||
| helpful linting output. In a future release it will automate some tasks (e.g., | ||
| adding copyright and licensing information headers to specified files). | ||
|
|
@@ -97,9 +102,7 @@ The versions follow [semantic versioning](https://semver.org). | |
|
|
||
| - The DEP5 file which bulk-licenses directories as a sort of global | ||
| configuration file was moved from `debian/copyright` to `.reuse/dep5`. | ||
|
|
||
| - The three steps have been changed from | ||
|
|
||
| 1. Provide the exact text of each license used | ||
| 2. Include a copyright notice and license in each file | ||
| 3. Provide an inventory for included software | ||
|
|
@@ -115,12 +118,9 @@ The versions follow [semantic versioning](https://semver.org). | |
| - The specification no longer makes a recommendation on how to deal with | ||
| licenses such as BSD and MIT that themselves contain editable copyright | ||
| notices. | ||
|
|
||
| - License files can now only be placed in `LICENSES/[spdx-identifier].[ext]` | ||
| files, instead of the default `LICENSE`, `COPYING`, etc.. As a result, the | ||
| `Valid-License-Identifier` tag is no longer needed. | ||
|
|
||
| - The specification no longer makes any mention of version control systems to | ||
| track copyright. | ||
|
|
||
| - The specification no longer mentions a bill of materials (SPDX Document). | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.