Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Prepare 3.2 version of specification #133

Merged
merged 55 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from 50 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
d3e4bc1
Bump to 3.2
carmenbianca Oct 17, 2023
8f7fa84
Add Snippet as defined term
carmenbianca Oct 17, 2023
e7e6051
Reformat section
carmenbianca Oct 17, 2023
4741404
Improve wording of paragraph
carmenbianca Oct 17, 2023
d547fb0
Improve definition of Copyright Notices
carmenbianca Oct 17, 2023
2993608
Spelling
carmenbianca Oct 17, 2023
9f9ebbf
Improve order of precedence
carmenbianca Oct 17, 2023
0426d6c
Yank 3.1 in change log
carmenbianca Oct 17, 2023
779c2f7
Adjust and add change log entries
carmenbianca Oct 17, 2023
5cfce12
Improve Snippet section
carmenbianca Oct 24, 2023
26018ff
Add 'Contributors to project' as example
carmenbianca Oct 24, 2023
19aa3a1
Add REUSE.toml
carmenbianca Jan 4, 2024
363300a
Ignore COPYING and LICENSE
carmenbianca Jan 4, 2024
f1fffdb
Remove unneeded capital letter
carmenbianca Jan 4, 2024
ffadfd5
Add extra example
carmenbianca Feb 2, 2024
327414a
Clarify override of `.license` files
carmenbianca Feb 2, 2024
27f1b16
Reword comment headers to correctly use MUST
carmenbianca Feb 2, 2024
f5cb72d
Remove a superfluous text now that snippets exist
carmenbianca Feb 2, 2024
a5675b1
Added hyperlink to Format of Copyright Notices section
carmenbianca Feb 2, 2024
0132b66
Move ignore block to own section
carmenbianca Feb 2, 2024
f7035cb
Improve the wording for the precedence algorithms
carmenbianca Feb 2, 2024
541c026
Add a missing word
carmenbianca Feb 29, 2024
8a45ad4
Make copyright and licensing keys optional in toml
carmenbianca Mar 1, 2024
dd8acc2
Clarify glob matches
carmenbianca Mar 1, 2024
0dc31da
REUSE.toml and DEP5 are mutually exclusive
carmenbianca Mar 1, 2024
895e3a9
Do not match base name
carmenbianca Mar 1, 2024
c239896
Backticks around REUSE.toml
carmenbianca Mar 1, 2024
3e840f7
Reword path key
carmenbianca Mar 1, 2024
8869ee1
Rename toml precedence type to override
carmenbianca Mar 1, 2024
3fd4eec
COPYING and LICENSE can take file extensions
carmenbianca Apr 27, 2024
e6af184
Update change log
carmenbianca Apr 27, 2024
ce294f2
Small fixes
carmenbianca Apr 27, 2024
ce8b980
Remove empty lines in change log
carmenbianca Apr 27, 2024
1952f88
Make snippets and ignore block sections subsections of comment header
carmenbianca Apr 27, 2024
25e6376
Improve DEP5 example to match REUSE.toml example
carmenbianca Apr 27, 2024
88b37eb
Add 'comprehensive' goal to introduction blurb
carmenbianca Apr 27, 2024
00e6295
More accurate description of glob matching
carmenbianca Apr 27, 2024
70995dd
Add unreleased section to change log
carmenbianca Apr 28, 2024
ce8588d
Move deprecation notice to its own section in change log
carmenbianca Apr 28, 2024
b0ee22a
Clarify COPYING and LICENSE inclusion
carmenbianca Apr 28, 2024
dc41318
Specify that non-license files cannot be in LICENSES/
carmenbianca Apr 28, 2024
ce4c36a
Replace NGO with Organisation
carmenbianca Apr 28, 2024
16f0b6e
Easier language for Snippets
carmenbianca Apr 28, 2024
7eefa3c
Recommend comment header above all others
carmenbianca Apr 28, 2024
21dd034
Allow user to include other keys and tables in TOML
carmenbianca Apr 28, 2024
9496bdd
Be more explicit about path separators
carmenbianca Apr 28, 2024
1a36bd0
Be more explicit about DEP5 deprecation
carmenbianca Apr 28, 2024
2be6315
Fix John's e-mail
carmenbianca Apr 28, 2024
2f73815
Simplify globbing
carmenbianca Apr 28, 2024
3f8ea8f
Reduce spacing between list elements
carmenbianca Apr 28, 2024
4e15864
Replace Copyright and Licensing Information with Licensing Information
carmenbianca May 21, 2024
738c41b
Add clearer (but tautological) information
carmenbianca May 21, 2024
5e6e482
Define TOML in spec
carmenbianca May 21, 2024
7bddcad
More explicitly state that REUSE.toml only covers its own directory
carmenbianca May 21, 2024
72aa8a8
Explicitly mention `.license` files
carmenbianca May 21, 2024
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
44 changes: 22 additions & 22 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
carmenbianca marked this conversation as resolved.
Show resolved Hide resolved

### 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

Expand All @@ -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).
Expand All @@ -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
Expand All @@ -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).
Loading