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.

Sign up for GitHub

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

Jump to bottom

Conform BSD-2-Clause and BSD-3-Clause text to SPDX #9813

Merged
merged 1 commit into from
Mar 17, 2024
Merged

Conform BSD-2-Clause and BSD-3-Clause text to SPDX #9813

merged 1 commit into from
Mar 17, 2024

Conversation

ffaf1
Copy link
Collaborator

@ffaf1 ffaf1 commented Mar 15, 2024 •
edited
Loading

cabal init text for BSD-2-Clause and BSD-3-Clause licence differed slightly from the one published at SPDX. [1] [2]

This caused some problems to users when dealing with licence-recognition software. [3]

[1] https://spdx.org/licenses/BSD-2-Clause.html
[2] https://spdx.org/licenses/BSD-3-Clause.html
[3] https://discourse.haskell.org/t/non-standard-license-generated-by-stack-new/9059

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Any changes that could be relevant to users have been recorded in the changelog.
  • The documentation has been updated, if necessary.
  • Manual QA notes have been included.
  • Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!) automated tests not needed

QA Notes

  1. cabal init and a series of ⏎ (it should select a BSD licence)
  2. LICENSE file does not contain the sentence “All rights reserved.”.

@ffaf1 ffaf1 linked an issue Mar 15, 2024 that may be closed by this pull request
cabal init generates non-standard licences #9812
Closed
@ffaf1
Copy link
Collaborator Author

ffaf1 commented Mar 15, 2024

Two considerations:

  • We should not fix our own LICENSE files.
  • I have gone through GPLv2 and bar from very few cosmetic changes (e.g. “one line to give the program's name and an idea of what it does.” vs. “one line to give the program's name and a brief idea of what it does.”, italics mine) they are the same.

ulysses4ever
ulysses4ever approved these changes Mar 15, 2024
View reviewed changes
Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

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

Perfetto, grazie!

glyn
glyn approved these changes Mar 17, 2024
View reviewed changes
Copy link

@glyn glyn left a comment

Choose a reason for hiding this comment

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

Thanks for this. LGTM.

@ulysses4ever ulysses4ever added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Mar 17, 2024
@ulysses4ever
Copy link
Collaborator

Merge-me?

@ffaf1 ffaf1 added the merge me Tell Mergify Bot to merge label Mar 17, 2024
@ffaf1 @Mikolaj
Conform BSD-2-Clause and BSD-3-Clause text to SPDX
1e86730 
`cabal init` text for BSD-2-Clause and BSD-3-Clause licence differed
slightly from the one published at SPDX. [1] [2]

This caused some problems to users when dealing with licence-recognition
software. [3]

[1] https://spdx.org/licenses/BSD-2-Clause.html
[2] https://spdx.org/licenses/BSD-3-Clause.html
[3] https://discourse.haskell.org/t/non-standard-license-generated-by-stack-new/9059
@ffaf1 ffaf1 added the attention: needs-manual-qa PR is destined for manual QA label Mar 17, 2024
@mergify mergify bot merged commit 99c21ba into haskell:master Mar 17, 2024
55 checks passed
@jasagredo
Copy link
Collaborator

Confirmed working on Windows. There are however some very small nitpicks:

  • In BSD-3-Clause, we use * for itemizing, the official license text uses numbering.
  • We output (in my example) Copyright (c) 2024, Javier Sagredo. and the license says it should be Copyright (c) 2024 Javier Sagredo. Notice the trailing dot and the comma.
  • In Windows the file is printed with CRLF (probably doesn't matter?):
➜ file LICENSE
LICENSE: ASCII text, with CRLF line terminators

@jasagredo jasagredo added the tested-on: windows QA has been successful on Windows label Mar 24, 2024
@ffaf1
Copy link
Collaborator Author

ffaf1 commented Mar 25, 2024

Thanks, it makes sense, I will make a follow up patch to this.

@glyn
Copy link

glyn commented Mar 25, 2024

I wonder about "automated tests not needed", given that it was possible for the text to deviate from what was required.

@ffaf1
Copy link
Collaborator Author

ffaf1 commented Apr 9, 2024

@mergify backport 3.12

@mergify Mergify
Copy link
Contributor

mergify bot commented Apr 9, 2024 •
edited
Loading

backport 3.12

✅ Backports have been created

@ffaf1
Copy link
Collaborator Author

ffaf1 commented Apr 9, 2024

(I will address both of your comments when I have time, if you don’t do it before me!)

@mergify mergify bot mentioned this pull request Apr 9, 2024
Merged
5 tasks
mergify bot added a commit that referenced this pull request Apr 9, 2024
@mergify
Merge pull request #9874 from haskell/mergify/bp/3.12/pr-9813
0a16cf7 
Conform BSD-2-Clause and BSD-3-Clause text to SPDX (backport #9813)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glyn glyn glyn approved these changes

@geekosaur geekosaur geekosaur approved these changes

@ulysses4ever ulysses4ever ulysses4ever approved these changes

Assignees
No one assigned
Labels
attention: needs-manual-qa PR is destined for manual QA merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge tested-on: windows QA has been successful on Windows
Projects
Manual QA board
Status: To Test
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

cabal init generates non-standard licences
6 participants
@ffaf1 @ulysses4ever @jasagredo @glyn @geekosaur @Kleidukos