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

annotations: Use SPDX License Expressions for licenses #680

Merged
merged 1 commit into from
May 19, 2017

Conversation

wking
Copy link
Contributor

@wking wking commented May 18, 2017

Instead of comma-separated short identifiers, which have unclear semantics (are the delimiters AND or OR?). I don't see any discussion of the syntax for this field in #636 (which landed it), but I'd floaded license expressions before in the sub-thread starting here. @gregkh had pushed back against my earlier proposal (licensing information on descriptors) with:

No, that's not going to work at all, you can't properly describe the license for a whole layer in any form of a string that could be standardized or parsed. SPDX is great for describing the individual licenses of things, but not for a collection of things, which almost always has an arbitrary license (example, what's the license, in a simple string, for a Ubuntu base layer?)

But SPDX License Expressions are both more expressive and better defined than the current comma delimiters. Everything you could have said with the comma-delimited string you can say more clearly with a SPDX License Expression. And because the syntax is not OCI-specific, you're more likely to be able to find tooling that handles these values out of the box.

There are other annotation adjustments in flight with #678, but that's not currently touching the licenses entry.

@wking wking force-pushed the spdx-license-expressions branch from aa63dac to 25588f0 Compare May 18, 2017 21:22
Instead of comma-separated short identifiers, which have unclear
semantics (are the delimiters AND or OR?).  I don't see any discussion
of the syntax for this field in [1] (which landed it), but I'd floaded
license expressions before in the sub-thread starting at [2].  Greg
had pushed back against my earlier proposal (licensing information on
descriptors) with [3]:

> No, that's not going to work at all, you can't properly describe the
> license for a whole layer in any form of a string that could be
> standardized or parsed. SPDX is great for describing the individual
> licenses of things, but not for a collection of things, which almost
> always has an arbitrary license (example, what's the license, in a
> simple string, for a Ubuntu base layer?)

But SPDX License Expression are both more expressive and better
defined than the current comma delimiters.  Everything you could have
said with the comma-delimited string you can say more clearly with a
SPDX License Expression.  And because the syntax is not OCI-specific,
you're more likely to be able to find tooling that handles these
values out of the box.

[1]: opencontainers#636
[2]: opencontainers#501 (comment)
[3]: opencontainers#501 (comment)

Signed-off-by: W. Trevor King <wking@tremily.us>
@vbatts
Copy link
Member

vbatts commented May 19, 2017

I remember greg saying that. I'm not familiar with spdx-expressions and would wager that many would have to get familiarized with it.
All in all it is clearer than just comma-delimited.
👍

Approved with PullApprove

@wking
Copy link
Contributor Author

wking commented May 19, 2017

I'm not familiar with spdx-expressions and would wager that many would have to get familiarized with it.

That SPDX appendix isn't very long ;). Reading through it a few times seems better than inventing an OCI-specific syntax that is more limited. If maintainers want to limit what you can say (for some reason), then making licenses AND (or OR) delimeted would preserve the current semantics as a subset of SPDX License Expressions.

All in all it is clearer than just comma-delimited.

So "I'm leaning towards LGTM but want to think about it more and/or hear what others think"? Or is there some way I can adjust the wording to make you happier now?

@vbatts
Copy link
Member

vbatts commented May 19, 2017

👍 == LGTM

@philips
Copy link
Contributor

philips commented May 19, 2017

LGTM

Approved with PullApprove

@vbatts vbatts merged commit 5f8311f into opencontainers:master May 19, 2017
@vbatts vbatts mentioned this pull request May 19, 2017
@wking wking deleted the spdx-license-expressions branch September 18, 2017 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants