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

Conversation

carmenbianca
Copy link
Member

@carmenbianca carmenbianca commented Oct 17, 2023

I'm creating a single PR for this because most changes were already pushed in separate PRs. This PR contains clean-ups and fixes before we can formally release 3.2.

Fixes fsfe/reuse-tool#868

  • Add a date to the specification.

Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Copy link
Member

@mxmehl mxmehl left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Show resolved Hide resolved
spec.md Show resolved Hide resolved

## Format of copyright notices
A Copyright Notice MUST start with a tag, word or symbol (collectively:
Copy link
Collaborator

Choose a reason for hiding this comment

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

At this point, we can be bold enough to make it stricter and deprecate all Copyright Notices that do not start with the appropriate SPDX tag.

Allowing for other formats was a temporary workaround that made sense to lessen the barrier for wider adoption, when REUSE was still new and we were inventing things that did not exist yet. But with SPDX File Tags (and SPDX Snippet Tags) now being a thing in an ISO standard, all we’re doing here is encouraging people to ignore part of the SPDX ISO standard.

Even within REUSE itself it causes inconsistency:

  • dep5 requires a Copyright tag, and so do we
  • reuse.yaml I very much imagine cannot work without relying on a tag
  • the in-line Snippets section explicitly says that SPDX Snippet Tags have to be used (makes sense, since the whole thing is covered within the SPDX spec now)
  • it is only the per-file copyright notice where we still allow a more lax approach

spec.md Outdated Show resolved Hide resolved
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
I removed some stuff that was already defined in the SPDX spec, and
reworded things to be a little clearer.

Signed-off-by: Carmen Bianca BAKKER <[email protected]>
Co-Authored-By: Matija Šuklje <[email protected]>

Signed-off-by: Carmen Bianca BAKKER <[email protected]>
@carmenbianca
Copy link
Member Author

Gave this another go. The big change is that I overhauled the snippet section. Some subtle changes besides.

@carmenbianca
Copy link
Member Author

We should add a date to the spec.

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Show resolved Hide resolved
spec.md Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Show resolved Hide resolved
spec.md Show resolved Hide resolved
@carmenbianca
Copy link
Member Author

carmenbianca commented Nov 27, 2023

Let's fix the issue raised in fsfe/reuse-tool#868 (DONE)

Signed-off-by: Carmen Bianca BAKKER <[email protected]>
spec.md Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Show resolved Hide resolved
spec.md Outdated
Comment on lines 118 to 119
Additionally, you can associate Copyright and Licensing Information with
Snippets inside of files.
Copy link
Member

Choose a reason for hiding this comment

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

Can we refer to the separate section, or mention it somehow (like "see below" or so)?

Copy link
Member Author

Choose a reason for hiding this comment

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

sure, agree

Copy link
Member Author

Choose a reason for hiding this comment

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

I am deciding against this because everything in this section is documented in its subsections. This text is just a small preamble, and the relevant section here is almost immediately below the referenced text.

spec.md Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Show resolved Hide resolved
@carmenbianca
Copy link
Member Author

I'm going to merge this following the 10 May coordination meeting.

Please open new issues for things that aren't quite right.

@carmenbianca carmenbianca merged commit 4e16ac2 into fsfe:main May 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistency between the tool behaviour and the spec
5 participants