cabal icon indicating copy to clipboard operation
cabal copied to clipboard

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

Open ffaf1 opened this issue 2 years ago • 1 comments

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:

  • [x] Patches conform to the coding conventions.
  • [x] Any changes that could be relevant to users have been recorded in the changelog.
  • [x] The documentation has been updated, if necessary.
  • [x] Manual QA notes have been included.
  • [x] ~~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 avatar Mar 15 '24 16:03 ffaf1

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.

ffaf1 avatar Mar 15 '24 16:03 ffaf1

Merge-me?

ulysses4ever avatar Mar 17 '24 11:03 ulysses4ever

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 avatar Mar 24 '24 15:03 jasagredo

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

ffaf1 avatar Mar 25 '24 10:03 ffaf1

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

glyn avatar Mar 25 '24 17:03 glyn

@mergify backport 3.12

ffaf1 avatar Apr 09 '24 14:04 ffaf1

backport 3.12

✅ Backports have been created

mergify[bot] avatar Apr 09 '24 14:04 mergify[bot]

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

ffaf1 avatar Apr 09 '24 14:04 ffaf1