search

spdx / spdx-spec

The SPDX specification in MarkDown and HTML formats.
https://spdx.github.io/spdx-spec/
Other
289 stars 141 forks source link

Remove + from valid idstring values and consistently link to appendix IV #16

Open wking opened 7 years ago

wking commented 7 years ago

The 2.1 spec is not particularly DRY on idstring values. There are a number of local definitions that match up with 1*(ALPHA / DIGIT / "-" / "."), a definition that includes + (perhaps from before it was a Licence Expression operator?) and a “defined in Appendix” (without specifying which appendix). I think we should extend our use of ABNF to include more than just appendix IV. We'd define idstring (or just id?) in the first place we needed it (here?), and then later sections would link that earlier definition and consume it's ABNF rule.

I'm happy to work up a PR for this if it sounds useful.

kestewart commented 7 years ago

Talked on call and agreed a good target for 2.2. Pull request welcomed.

wking commented 7 years ago

Pull request welcomed.

I started looking into this, but decided that I'd rather follow the XML spec and have an early section for these common constructs. However, if I add a chapter 2 for common constructs, I'll have to renumber the following chapters, update their section numbers, and update any internal references. I'm really missing LaTeX or some other system with auto-numbered sections and references ;). I'll grind through the renumbering, but I'd like to wait until #8 lands first.