THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx

Difference between revisions of "Technical Team/Use Cases/2.0/Reference Implementations"

From SPDX Wiki
Jump to: navigation, search
(Convert to MediaWiki syntax)
 
Line 1: Line 1:
<ol type="1"><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Title:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">&nbsp; Reference Implementations </span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Primary Actor:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">&nbsp; <span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Provideor of a&nbsp; </span>reference implementation<br /></span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Goal in Context:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN"> To include with the copyrightable artifacts distributed by the reference implementation SPDX data describing it's licensing information and the type of copyrightable artifacts. &nbsp;The reference implementation is typically a hardware device (board) that comes in a box with software pre-flashed to demonstrate some functionality, documentation, cables and so forth. There may also be DVDs, CDs, an SD card, etc that could contain host development tools, the software for the pieces running on the flash, additional SDKs, applications (test and/or demonstration), a distribution of some sort and so forth. This can be a very large amount of material and software and this use case could be seen as a superset of the application, SDK, etc use cases. Note: Some artifacts like Makefiles, sample data files and/or other project files (e.g. IDE project files), scripts and so forth may be machine generated and thus not have a copyright or license and other “incidental” project files may not have copyrights as well.</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN"><span style="mso-spacerun: yes;">&nbsp;</span>Stakeholders and Interests:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">&nbsp; </span></li><ol type="1"><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Reference Implementation Provider:&nbsp;</span></strong></li><ol type="1"><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level3 lfo1; tab-stops: list 1.5in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">To communicate the licensing information for their copyrightable artifacts and the type of artifacts.</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level3 lfo1; tab-stops: list 1.5in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">To have their licenses respected</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level3 lfo1; tab-stops: list 1.5in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">To help consumers understand what they are getting.</span></li></ol><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Consumers of Reference Implementation artifacts:</span></strong></li><ol type="1"><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level3 lfo1; tab-stops: list 1.5in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">To receive accurate and clear information of licensing of artifacts </span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level3 lfo1; tab-stops: list 1.5in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">To be able to comply with licenses for artifacts </span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level3 lfo1; tab-stops: list 1.5in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.</span></li></ol></ol><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Preconditions:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">&nbsp; </span></li><ol type="1"><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Upstream has selected licenses for the copyrightable artifacts originating with the project (package, files, etc) </span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Upstream has indentified license data for other copyrightable artifacts they consume</span></li></ol><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Main Success Scenario:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN"> Reference Implementation Provider communicates accurate and complete licensing information for the copyrightable artifacts in an SPDX data format.</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Failed End Condition:</span></strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN"> Reference Implementation Provider communicates inaccurateand/or incomplete licensing information for the copyrightable artifacts.</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level1 lfo1; tab-stops: list .5in;"><strong><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Trigger:</span></strong></li><ol type="1"><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Reference implementation release (ship)</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Commit time?</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Checkout from a repository?</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Inclusion of external artifacts into the reference platform</span></li><li class="MsoNormal" style="background: white; margin: 0in 0in 0pt; color: #4d4d4d; mso-margin-top-alt: auto; mso-margin-bottom-alt: auto; mso-list: l0 level2 lfo1; tab-stops: list 1.0in;"><span style="font-size: 10pt; font-family: Arial; mso-ansi-language: EN;" lang="EN">Posting of updated software for a reference implementation</span></li></ol></ol><p class="MsoNormal" style="margin: 0in 0in 0pt;"><strong><span style="font-size: 10pt; color: #4d4d4d; font-family: Arial; mso-ansi-language: EN;" lang="EN">Notes:</span></strong><span style="font-size: 10pt; color: #4d4d4d; font-family: Arial; mso-ansi-language: EN;" lang="EN"> &nbsp;This use case can be viewed as a superset of the application, SDK, distribution, Yocto, etc uses cases where many things are aggregated together. There may be a lot of SPDX documents. Software on Reference Implementations are typically updated and could be posted for download from a website or made accessible though a source code control system. (as examples).</span></p>
+
# '''Title:''' Reference Implementations
 +
# '''Primary Actor:''' Provideor of a reference implementation
 +
# '''Goal in Context:''' To include with the copyrightable artifacts distributed by the reference implementation SPDX data describing it's licensing information and the type of copyrightable artifacts. The reference implementation is typically a hardware device (board) that comes in a box with software pre-flashed to demonstrate some functionality, documentation, cables and so forth. There may also be DVDs, CDs, an SD card, etc that could contain host development tools, the software for the pieces running on the flash, additional SDKs, applications (test and/or demonstration), a distribution of some sort and so forth. This can be a very large amount of material and software and this use case could be seen as a superset of the application, SDK, etc use cases. Note: Some artifacts like Makefiles, sample data files and/or other project files (e.g. IDE project files), scripts and so forth may be machine generated and thus not have a copyright or license and other “incidental” project files may not have copyrights as well.
 +
# ''' Stakeholders and Interests:'''
 +
## '''Reference Implementation Provider: '''
 +
### To communicate the licensing information for their copyrightable artifacts and the type of artifacts.
 +
### To have their licenses respected
 +
### To help consumers understand what they are getting.
 +
## '''Consumers of Reference Implementation artifacts:'''
 +
### To receive accurate and clear information of licensing of artifacts
 +
### To be able to comply with licenses for artifacts
 +
### To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.
 +
# '''Preconditions:'''
 +
## Upstream has selected licenses for the copyrightable artifacts originating with the project (package, files, etc)
 +
## Upstream has indentified license data for other copyrightable artifacts they consume
 +
# '''Main Success Scenario:''' Reference Implementation Provider communicates accurate and complete licensing information for the copyrightable artifacts in an SPDX data format.
 +
# '''Failed End Condition:''' Reference Implementation Provider communicates inaccurateand/or incomplete licensing information for the copyrightable artifacts.
 +
# '''Trigger:'''
 +
## Reference implementation release (ship)
 +
## Commit time?
 +
## Checkout from a repository?
 +
## Inclusion of external artifacts into the reference platform
 +
## Posting of updated software for a reference implementation
 +
 
 +
'''Notes:''' This use case can be viewed as a superset of the application, SDK, distribution, Yocto, etc uses cases where many things are aggregated together. There may be a lot of SPDX documents. Software on Reference Implementations are typically updated and could be posted for download from a website or made accessible though a source code control system. (as examples).
 +
 
 +
[[Category:Technical]]

Latest revision as of 13:16, 7 March 2013

  1. Title: Reference Implementations
  2. Primary Actor: Provideor of a reference implementation
  3. Goal in Context: To include with the copyrightable artifacts distributed by the reference implementation SPDX data describing it's licensing information and the type of copyrightable artifacts. The reference implementation is typically a hardware device (board) that comes in a box with software pre-flashed to demonstrate some functionality, documentation, cables and so forth. There may also be DVDs, CDs, an SD card, etc that could contain host development tools, the software for the pieces running on the flash, additional SDKs, applications (test and/or demonstration), a distribution of some sort and so forth. This can be a very large amount of material and software and this use case could be seen as a superset of the application, SDK, etc use cases. Note: Some artifacts like Makefiles, sample data files and/or other project files (e.g. IDE project files), scripts and so forth may be machine generated and thus not have a copyright or license and other “incidental” project files may not have copyrights as well.
  4. Stakeholders and Interests:
    1. Reference Implementation Provider:
      1. To communicate the licensing information for their copyrightable artifacts and the type of artifacts.
      2. To have their licenses respected
      3. To help consumers understand what they are getting.
    2. Consumers of Reference Implementation artifacts:
      1. To receive accurate and clear information of licensing of artifacts
      2. To be able to comply with licenses for artifacts
      3. To be able to subset, extend, or aggregate artifacts and pass on clear authoritative verifiable license for the resulting new copyrightable artifacts.
  5. Preconditions:
    1. Upstream has selected licenses for the copyrightable artifacts originating with the project (package, files, etc)
    2. Upstream has indentified license data for other copyrightable artifacts they consume
  6. Main Success Scenario: Reference Implementation Provider communicates accurate and complete licensing information for the copyrightable artifacts in an SPDX data format.
  7. Failed End Condition: Reference Implementation Provider communicates inaccurateand/or incomplete licensing information for the copyrightable artifacts.
  8. Trigger:
    1. Reference implementation release (ship)
    2. Commit time?
    3. Checkout from a repository?
    4. Inclusion of external artifacts into the reference platform
    5. Posting of updated software for a reference implementation

Notes: This use case can be viewed as a superset of the application, SDK, distribution, Yocto, etc uses cases where many things are aggregated together. There may be a lot of SPDX documents. Software on Reference Implementations are typically updated and could be posted for download from a website or made accessible though a source code control system. (as examples).