THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx
Difference between revisions of "Documents/Producing SPDX Documents"
(→Overview) |
(→Overview) |
||
| Line 26: | Line 26: | ||
<br/> | <br/> | ||
| − | SPDX documents describe the licensing associated with a | + | SPDX documents describe the licensing associated with a files. These files can be organized into what we call a "Package". A package is merely a grouping of files, with some association to each other as defined by the creator of the document. In general, the association should be obvious, such as an SPDX document for a software library or application. SPDX Documents can use one of two formats: |
Tag/value -a simple text based format. | Tag/value -a simple text based format. | ||
| Line 32: | Line 32: | ||
RDF/xml - a Resource Description Format developed by the W3C. | RDF/xml - a Resource Description Format developed by the W3C. | ||
Here is an example you can view. | Here is an example you can view. | ||
| + | |||
You can use either format and there are SPDX tools to convert one format to another. The format you use will be based on your own factors, preference, tools and use. | You can use either format and there are SPDX tools to convert one format to another. The format you use will be based on your own factors, preference, tools and use. | ||
Revision as of 14:10, 26 October 2016
|
SPDX Tech Report |
PRODUCING SPDX DOCUMENTS
version 0.1
WORKING DRAFT
Contents
- 1 Overview
- 2 Structure of an SPDX Document
- 3 Tooling
- 4 Strategies
- 5 Best Practices
- 6 Examples
- 6.1 A Simple Example (aka hello world)
- 6.2 Document with minimum Required Fields
- 6.3 SPDX document for a binary delivery - no relationships
- 6.4 SPDX document for a binary delivery - uses relationships
- 6.5 SPDX document for an application delivery (source, binaries, documents, etc) - more expressive use of relationships
Overview
SPDX documents describe the licensing associated with a files. These files can be organized into what we call a "Package". A package is merely a grouping of files, with some association to each other as defined by the creator of the document. In general, the association should be obvious, such as an SPDX document for a software library or application. SPDX Documents can use one of two formats:
Tag/value -a simple text based format. Here is an example you can view. RDF/xml - a Resource Description Format developed by the W3C. Here is an example you can view.
You can use either format and there are SPDX tools to convert one format to another. The format you use will be based on your own factors, preference, tools and use.
Structure of an SPDX Document
The most current version of the specification can be found here: Specifications
Packages and Relationships
Tooling
SPDX Workgroup Tools
Community Tools
Commercial Tools
Strategies
Best Practices
Editors Note: we may move this section to its own document upon completion.
Examples
The following application will be used in the examples for this section. As the examples are meant to build on one another in terms of the use case and complexity they show. Some examples may use only portions of the application. Each example will state what is used. By using one application, going through the examples should be easier. The application used is time, version 1.7 with some made up directories added (okay alone it was too simple).
Download the example here
