Re: explanation for ensuring no duplicate identifiers


W. Trevor King
 

On Thu, Jul 05, 2018 at 06:16:56PM -0600, J Lovejoy wrote:
Back to the Short Identifier additions are: characters, given the
various feedback on this thread, here is an updated suggestion.
I'm fine with this proposal going out as you have it, but I've put a
few suggestions inline in case you want to pick them up.

• Short identifier to be used to identify a license or exception
match to licenses or exceptions contained on the SPDX License List
in the context of an SPDX file, in source file, or elsewhere
This matches what's currently live [1], but it could probably be
tightened up to something like:

Short identifiers identify licenses and exceptions from the SPDX
License List in the context of an SPDX file, a source file, or
elsewhere

• Short identifiers have no spaces in them consist of ASCII letters
(A-Za-z), digits (0-9), full stops (.) and hyphen or minus signs
(-)
I think it is sufficient to list the allowed characters:

Short identifiers consist of ASCII letters (A-Za-z), digits (0-9),
full stops (.), and hyphen/minus signs (-).

And then, if you want to draw attention to spaces in particular, add a
second sentence to that list item:

They do not contain spaces or other characters except those
mentioned in the previous sentence.

• Where applicable, the abbreviation will be followed by a dash and
then the version number, in X.Y format
This line is currently live [1], but do we need to keep it? Not all
of our versions are X.Y. For example, W3C-19980720 [2] is in YYYYMMDD
format. Perhaps that falls under "where applicable", but why call out
one specific versioning approach?

• Short identifiers must not be duplicative and must be different
from all pre-existing short identifiers.
• While short identifiers can be treated as case insensitive, it is
encouraged to use the canonical short identifier casing.
These cover the two points I think need to get covered. So while I
prefer my previously-suggested wording [3], I'm fine with this
wording.

Cheers,
Trevor

[1]: https://spdx.org/spdx-license-list/license-list-overview
[2]: https://github.com/spdx/license-list-XML/blob/v3.1/src/W3C-19980720.xml
[3]: Subject: Re: explanation for ensuring no duplicate identifiers
Date: Mon, 18 Jun 2018 11:18:34 -0700
Message-ID: <20180618181834.GD25466@valgrind>

--
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

Join Spdx-legal@lists.spdx.org to automatically receive all group messages.