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

Clarify naming rules for custom licenses #138

Open
ryandesign opened this issue Dec 9, 2023 · 1 comment
Open

Clarify naming rules for custom licenses #138

ryandesign opened this issue Dec 9, 2023 · 1 comment
Labels
enhancement New feature or request faq FAQ

Comments

@ryandesign
Copy link

The FAQ says:

reuse-docs/faq.md

Lines 544 to 555 in 0913b0a

If you have a custom or modified license that does not appear in the SPDX
License List, place your license in the file
`LICENSES/LicenseRef-MyLicense.txt`. By naming your license as such, tools that
speak SPDX will still be able to recognise your license.
In this example, the header in files covered by this custom license may look
like the following:
```
# SPDX-License-Identifier: LicenseRef-MyLicense
# SPDX-FileCopyrightText: 2017 Jane Doe <[email protected]>
```

It is entirely unclear what is meant by "as such". Does it mean:

  1. the file must be in the LICENSES directory
  2. the file must be in the LICENSES directory and end with .txt
  3. the file must be in the LICENSES directory and end with -MyLicense.txt
  4. the file must be in the LICENSES directory and begin with LicenseRef- and end with .txt

I believe the answer is probably 4 but please specify it in the FAQ.

@silverhook
Copy link
Collaborator

The final result should be 4, yes.

@carmenbianca carmenbianca added enhancement New feature or request spec Specification faq FAQ and removed spec Specification labels Jan 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request faq FAQ
Projects
None yet
Development

No branches or pull requests

3 participants