THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx
Technical Team/Use Cases/2.0
From SPDX Wiki
We have several sources to begin pulling for SPDX Use Cases:
- The Pad from earlier conversations collected at <a href="http://spdx.org/wiki/use-cases-collected-20-discussion">Use Cases For SPDX 2.0 Discussion</a>
- The old <a href="https://fossbazaar.org/wiki/spdx-use-case-1">SPDX 1.0 Use Cases</a> as well as the <a href="http://spdx.org/system/files/ecosystem.jpg">SDPX 1.0 Use Case Picture</a>.
I'd like to propose that we flesh out use cases here by having a brief summary listed here as a link to a more detailed child page. Note, these use cases should be *doable* but in general not *required*. Any item listed here that is not a link, should have a child page created for it.
- Code commits
- <a href="http://spdx.org/wiki/committers-provides-spdx-data-code-being-committed">Committer provides SPDX data</a>
- <a href="http://spdx.org/wiki/contributor-makes-commit-subject-existing-spdx-data-project">Contributor makes commit subject to existing SPDX data of project</a>
- Contributor makes commit subject to existing SPDX data of a dual licensed project and selects one license
- Committer annotates source files with SPDX data
- Patches
- Patch provider provides SPDX data for the patch
- Patch provider provides SPDX data for the patch indicating it is licensed however the hell its applied
- Patch provider provides patch subject to existing SPDX data of project
- Patch provider provides a patch that modifies existing SPDX data of project
- <a href="http://spdx.org/wiki/spdx-20-usecase-upstream-maintainer-providing-spdx-data">Upstream maintainer providing SPDX data</a>
- <a href="http://spdx.org/wiki/upstream-maintainer-providing-spdx-data-source-archive">Upstream maintainer providing SPDX data in source archive</a>
- <a href="http://spdx.org/wiki/upstream-maintainer-providing-spdx-data-scm">Upstream maintainer providing SPDX data in SCM</a>
- Upstream maintainer providing SPDX data at a URL
- Project maintainer incorporates another project
- Project maintainer incorporates another project by including source
- Project maintainer incorporates another project by including binary
- Project maintainer incorporates another copyrightable artifact by reference (think maven, possibly linking cases)
- by static reference (the referenced library is included with a redistribution)
- by dynamic reference (express runtime dependency on the external library, but not redistributing it)
- Maven case
- Project maintainer pulling individual files out of another project (subsetting)
- Intermediate packager (rpm, deb, etc) passing on and adding to SPDX Data
- Intermediate packager builds source package from upstream source
- <a href="http://spdx.org/wiki/intermediate-packager-builds-source-package-upstream-source-provides-spdx-data">Intermediate packager builds source package from upstream source that provides SPDX data</a>
- Intermediate packager builds source package from upstream source that does not provide SPDX data
- Intermediate packager builds binary package from upstream source
- <a href="http://spdx.org/wiki/intermediate-packager-builds-binary-package-upstream-source-provides-spdx-data">Intermediate packager builds binary package from upstream source that provides SPDX data</a>
- Intermediate packager builds binary package from upstream source that does not provides SPDX data
- Intermediate packager adds patches to upstream source
- <a href="http://spdx.org/wiki/intermediate-packager-adds-patches-upstream-source-provides-spdx-data">Intermediate packager adds patches to upstream source that provides SPDX data</a>
- Intermediate packager adds patches to upstream source that does not provide SPDX data
- Intermediate packager adds someone else's patches to upstream source
- <a href="http://spdx.org/wiki/intermediate-packager-adds-someone-elses-patches-upstream-source-provides-spdx-data">Intermediate packager adds someone else's patches to upstream source that provides SPDX data</a>
- Intermediate packager adds someone else's patches to upstream source that does not provide SPDX data
- Intermediate packager subsetting upstream source
- <a href="http://spdx.org/wiki/intermediate-packager-subsetting-upstream-source-provides-spdx-data">Intermediate packager subsetting upstream source that provides SPDX data</a>
- Intermediate packager subsetting upstream source that does not provide SPDX data
- Intermediate packager chooses to distribute one of multiple available under licenses provided for by upstream (check with legal team)
- Build systems (build systems want to pass on SPDX data for the thing they are building)
- Yocto [Jack Manbeck]
- Maven
- Aggregator aggregating many 'copyrightable items' for redistribution
- Linux Distros [Kate Stewart]
- Embedded Images
- SDKs [Jack Manbeck]
- <a href="http://spdx.org/wiki/spdx-20-usecase-reference-implementations">Reference implementations </a>[Jack Manbeck]
- Eclipse/OSGI distributions
- <a href="http://spdx.org/wiki/spdx-20-usecase-application-which-ships-documentation-media-software">Application which ships with documentation + media + software</a> [Jack Manbeck]
- <a title="Use case details" href="http://spdx.org/wiki/application-which-ships-contrib-libraries">Application which ships with a contrib libraries</a> [Gary O'Neall]
- <a title="Use case details" href="http://spdx.org/wiki/application-which-ships-development-tools">Application which ships with development tools</a> [Gary O'Neall]
- Aggregators aggregating other aggregations for redistribution
- I just made a binary out of some source
- SPDX data indicating subset of the source that made it into a particular binary or binary package
- Asserting corrections to SPDX data provided by others further upstream
- Consumers receiving SPDX data
- Procurement needs to view it and review it
- Legal department needs to review
- Consuming code snippets (God help us all)
- Signoff/multiple signoff on SPDX data
- Contracts with multiple parties requiring signoff by all [Kate Stewart]
- Auditor scenario: given big pile of 'copyrightable items', creating Bill of Materials [Peter Williams]
- Sanity-checking Bill of Material
- outbound: validate that SPDX goes hand in hand with what's being shipped [Kirsten Newcomer]
- inbound: validate that SPDX goes hand in hand with what's being brought in
- Java complications [Richard Fontana]
Cross-cutting concerns:
- Provenance (the need to optionally use signing to validate who said what)
- Handling staleness of data
- Expressing applicable licensing as a function of Usage [Bill Schineller]
- Permissive licensed thing becomes restrictive as function of packaging (e.g. BSD file included in GPL becomes GPL)
Themes:
Looking at these Use Cases, there are some underlying themes:
- Root of data (closer to upstream the better)
- Subsetting of copyrightable things (and their SPDX data) (Note: Subsets of copyrightable things are usually also copyrightable things)
- Aggregation of copyrightable things (and their SPDX data) (Note: Aggregations of copyrightable things are usually also copyrightable things).