Documents/Producing SPDX Documents

SPDX Tech Report

---

PRODUCING SPDX DOCUMENTS
version 0.1
WORKING DRAFT

Overview

SPDX documents describe the licensing associated with a set of file or 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

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