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

Postulate that snippet tags be closed #95

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ This is the change log for the REUSE Specification.

### Fixed

- Clarified that snippet tags must be closed. This was technically already the
case with a certain reading of the SPDX specification, but it has now been
made explicit.

### Security

## 3.2 - 2024-07-03
Expand Down
4 changes: 3 additions & 1 deletion site/content/en/spec-3.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,14 @@ An example of a comment header:
#### In-line Snippet comments

Sometimes Licensing Information only applies to a certain Snippet instead of the
whole Commentable File. For these cases SPDX snippet tags MUST be used for that
whole Commentable File. For these cases, SPDX snippet tags MUST be used for that
Snippet (as defined in [SPDX Specification, Annex
Comment on lines -180 to 181
Copy link
Member Author

Choose a reason for hiding this comment

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

Eh, even when corrected, this language is awkward. Let's reword.

H](https://spdx.github.io/spdx-spec/v2.3/file-tags/#h3-snippet-tags-format)).
This means that Copyright Notices inside of Snippets MUST be prefixed with
`SPDX-SnippetCopyrightText`.

Each Snippet that is opened MUST be closed with `SPDX-SnippetEnd`.

Like with comment headers, the SPDX snippet tags SHOULD be commented.

A Snippet SHOULD contain both a Copyright Notice and an SPDX License Expression.
Expand Down
Loading