In the sandstorm-pkgdef.capnp file, the license field has this form by default:
license = (none = void).
This field is documented here. The documentation lacks examples of how to properly fill out this field, which makes it a little tricky to understand:
- Unclear from documentation why
void is valid here, since it's unreferenced in the documentation.
- No explanation of the overall structure of the two-element value. It appears that the first value is the general category (
openSource, none, proprietary), with the second value being more detail (so license = (openSource = mit) is valid; based on the description, it appears for proprietary licenses one would want to do license = (proprietary = "The full text of the license because the user will need to see it to accept it") ).
- If
publicDomain is chosen, no guidance on what the rest of the field should be. I infer from context it appears to be license = (publicDomain = void) but am unsure.
- No explanation of where
notices should go and they aren't referenced in the boilerplate sandstorm-pkgdef.capnp file.
Overall, docs are 90% of the way there, but examples of each of the above cases would really help.
In the
sandstorm-pkgdef.capnpfile, the license field has this form by default:license = (none = void).This field is documented here. The documentation lacks examples of how to properly fill out this field, which makes it a little tricky to understand:
voidis valid here, since it's unreferenced in the documentation.openSource,none,proprietary), with the second value being more detail (solicense = (openSource = mit)is valid; based on the description, it appears for proprietary licenses one would want to dolicense = (proprietary = "The full text of the license because the user will need to see it to accept it")).publicDomainis chosen, no guidance on what the rest of the field should be. I infer from context it appears to belicense = (publicDomain = void)but am unsure.noticesshould go and they aren't referenced in the boilerplatesandstorm-pkgdef.capnpfile.Overall, docs are 90% of the way there, but examples of each of the above cases would really help.