Skip to content

Commit

Permalink
Fix broken links between pages
Browse files Browse the repository at this point in the history
Repaired broken links after conversion using HTML anchor
Anchor <a name="1.8"></a> used instead of <a name="1.8"/> as
several MarkDown editors do not properly render the later
  • Loading branch information
tsteenbe committed Jul 16, 2017
1 parent 9cb45f8 commit cfa1b9d
Show file tree
Hide file tree
Showing 12 changed files with 119 additions and 119 deletions.
20 changes: 10 additions & 10 deletions chapters/1-rationale.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# 1 Rationale

## 1.1 Charter
## 1.1 Charter <a name="1.1"></a>

To create a set of data exchange standards that enable companies and organizations to share license and component information (metadata) for software packages and related content with the aim of facilitating license and other policy compliance.

## 1.2 Definition
## 1.2 Definition <a name="1.2"></a>

The Software Package Data Exchange (SPDX®) specification is a standard format for communicating the components, licenses, and copyrights associated with software packages. An SPDX file is associated with a particular software package or set of packages and contains information about it in the SPDX format.

## 1.3 Why is a common format for data exchange needed?
## 1.3 Why is a common format for data exchange needed? <a name="1.3"></a>

Companies and organizations (collectively “Organizations”) are widely using and reusing open source and other software packages. Compliance with the associated licenses requires a set of analysis activities and due diligence that each Organization performs independently, which may include a manual and/or automated scan of software and identification of associated licenses followed by manual verification. Software development teams across the globe use the same open source packages, but little infrastructure exists to facilitate collaboration on the analysis or share the results of these analysis activities. As a result, many groups are performing the same work leading to duplicated efforts and redundant information. The SPDX working group seeks to create a data exchange format so that information about software packages and related content may be collected and shared in a common format with the goal of saving time and improving data accuracy.

## 1.4 What does this specification cover?
## 1.4 What does this specification cover? <a name="1.4"></a>

**1.4.1** SPDX Document Creation Information: Meta data to associate analysis results with a specific version of the SPDX file and license for use, and provide information on how, when, and by whom the SPDX file was created.

Expand All @@ -30,7 +30,7 @@ Companies and organizations (collectively “Organizations”) are widely using

![Overview of SPDX 2.1 document contents](../img/spdx-2.1-document.png)

## 1.5 What is not covered in the specification?
## 1.5 What is not covered in the specification? <a name="1.5"></a>

**1.5.1** Information that cannot be derived from an inspection (whether manual or using automated tools) of the package to be analyzed.

Expand All @@ -42,7 +42,7 @@ Companies and organizations (collectively “Organizations”) are widely using

**1.5.5** Examples may contain “...” which indicate detailed text specific to the SPDX Document

## 1.6 Format Requirements
## 1.6 Format Requirements <a name="1.6"></a>

**1.6.1** Must be in a human readable form.

Expand All @@ -64,7 +64,7 @@ Companies and organizations (collectively “Organizations”) are widely using

**1.6.10** The convention in this specification is for the RDF examples to use `rdf:about="..."` to represent that a proper Universal Resource Indicator (URI) should be present.

## 1.7 Conformance
## 1.7 Conformance <a name="1.7"></a>

**1.7.1** A file can be designated an SPDX document, if it is compliant with the requirements of the SPDX Trademark License (See the SPDX Trademark Page).

Expand All @@ -76,13 +76,13 @@ Companies and organizations (collectively “Organizations”) are widely using

"This is not an official SPDX Specification. Portions herein have been reproduced from SPDX® Specification 2.1 found at spdx.org. These portions are Copyright © 2010-2016 Linux Foundation and its Contributors, and are licensed under the Creative Commons Attribution License 3.0 Unported by the Linux Foundation and its Contributors. All other rights are expressly reserved by Linux Foundation and its Contributors."

## 1.8 Differences from SPDX Specification 2.0
## 1.8 Differences from SPDX Specification 2.0 <a name="1.8"></a>

**1.8.1** Snippets have been added to allow a portion of a file to be identified as having different properties from the file it resides in. The use of snippets is completely optional and it is not manditory for snippets to be identified. See [section 5 Snippet Information](./5-snippet-information.md) for further details on the fields available to describe snippets.

**1.8.2** External Packages can now be refered to in SPDX documents. When there is no SPDX file information available to document the content of these external packages, then the filesAnnalyzed attribute on a package should be set to false. See [section 3.8](FIXME) Files Analyzed for more information.
**1.8.2** External Packages can now be refered to in SPDX documents. When there is no SPDX file information available to document the content of these external packages, then the filesAnnalyzed attribute on a package should be set to false. See [section 3.8](3-package-information.md#3.8) Files Analyzed for more information.

**1.8.3** Packages are now able to associate with an “External Reference” which allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package. See: section [3.21 External Reference](FIXME), [3.22 External Reference Comment](FIXME) and [Appendix VI: External Repository Identifiers](./appendix-VI-external-repository-identifiers.md) for more information.
**1.8.3** Packages are now able to associate with an “External Reference” which allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package. See: section [3.21 External Reference](3-package-information.md#3.21), [3.22 External Reference Comment](3-package-information.md#3.22) and [Appendix VI: External Repository Identifiers](./appendix-VI-external-repository-identifiers.md) for more information.

**1.8.4** The “Artifact of Project” fields at the file level are now deprecated, as they can be replaced by a relationship to the more descriptive External Packages.

Expand Down
28 changes: 14 additions & 14 deletions chapters/2-document-creation-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Cardinality: Mandatory, one.

Fields:

## 2.1 SPDX Version
## 2.1 SPDX Version <a name="2.1"></a>

**2.1.1** Purpose: Provide a reference number that can be used to understand how to parse and interpret the rest of the file. It will enable both future changes to the specification and to support backward compatibility. The version number consists of a major and minor version indicator. The major field will be incremented when incompatible changes between versions are made (one or more sections are created, modified or deleted). The minor field will be incremented when backwards compatible changes are made.

Expand Down Expand Up @@ -34,7 +34,7 @@ Example:
<specVersion>SPDX-2.1</specVersion>
</SpdxDocument>

## 2.2 Data License
## 2.2 Data License <a name="2.2"></a>

**2.2.1** Purpose: Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata"). The SPDX specification contains numerous fields where an SPDX document creator may provide relevant explanatory text in SPDX-Metadata.
Without opining on the lawfulness of "database rights" (in jurisdictions where applicable), such explanatory text is copyrightable subject matter in most Berne Convention countries.
Expand All @@ -60,7 +60,7 @@ Example:
<dataLicense rdf:resource="http://spdx.org/licenses/CC0-1.0" />
</SpdxDocument>

## 2.3 SPDX Identifier
## 2.3 SPDX Identifier <a name="2.3"></a>

**2.3.1** Purpose: Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally. To reference another SPDX document in total, this identifier should be used with the external document identifier preceding it. See the “Relationships between SPDX Elements” section for examples.

Expand All @@ -84,7 +84,7 @@ Example:
...
</spdx:SpdxDocument>

## 2.4 Document Name
## 2.4 Document Name <a name="2.4"></a>

**2.4.1** Purpose: Identify name of this document as designated by creator.

Expand Down Expand Up @@ -114,7 +114,7 @@ Example:
<name>ubuntu-14.04</name>
</SpdxDocument>

## 2.5 SPDX Document Namespace
## 2.5 SPDX Document Namespace <a name="2.5"></a>

**2.5.1** Purpose: Provide an SPDX document specific namespace as a unique absolute [Uniform Resource Identifier][URI] (URI) as specified in [RFC-3986][rfc3986], with the exception of the ‘#’ delimiter. The SPDX Document URI cannot contain a URI "part" (e.g. the "#" character), since the ‘#’ is used in SPDX element URIs (packages, files, snippets, etc) to separate the document namespace from the element’s SPDX identifier. Additionally, a scheme (e.g. “https:”) is required.

Expand All @@ -124,7 +124,7 @@ The URI must be unique for the SPDX document including the specific version of t

* `CreatorWebsite` is a website hosted by the creator of the document. (e.g. an SPDX document provided by SPDX would be spdx.org)
* `PathToSpdx` is a path to where SPDX documents are stored on the website (e.g. /spdx/spdxdocs)
* `DocumentName` is a name given to the SPDX Document itself, typically the (set of) package name(s) followed by the version. (see section 2.4).
* `DocumentName` is a name given to the SPDX Document itself, typically the (set of) package name(s) followed by the version. [(see section 2.4)](#2.4).
* `UUID` is a [universally unique identifier][URI]. The UUID could be a version 4 random UUID which can be generated from the [Online UUID Generator][uuid-gen] or a version 5 UUID generated from a sha1 checksum known to be unique for this specific SPDX document version.
* If the creator does not own their own website, a default SPDX CreatorWebsite and PathToSpdx can be used 'spdx.org/spdxdocs'. Note that the SPDX documents are not currently stored or accessible on this website. The URI is only used to create a unique ID following the above conventions.

Expand Down Expand Up @@ -157,7 +157,7 @@ Example:
<rdfs:comment>This document was created using SPDX 2.0 using licenses from the web site.</rdfs:comment>
</SpdxDocument>

## 2.6 External Document References
## 2.6 External Document References <a name="2.6"></a>

**2.6.1** Purpose: Identify any external SPDX documents referenced within this SPDX document.

Expand All @@ -172,11 +172,11 @@ where
[idstring] is a unique string containing letters, numbers, “.”, “-” or “+”.
[SPDX Document URI] is the unique ID for the external document

as defined in section 2.5 of that referenced document,
as defined in [section 2.5](#2.5) of that referenced document,

[Checksum] is a checksum of the external document following the checksum

format defined in section 3.9.
format defined in [section 3.9](3-package-information.md#3.9).

**2.6.5** Tag: `ExternalDocumentRef:`

Expand Down Expand Up @@ -209,7 +209,7 @@ Example:

Notes: in RDF, a namespace can be created for the external document reference if a short form name for the external reference is desired.

## 2.7 License List Version
## 2.7 License List Version <a name="2.7"></a>

**2.7.1** Purpose: An optional field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created.

Expand Down Expand Up @@ -238,7 +238,7 @@ Example:
<licenseListVersion>2.0</licenseListVersion>
</CreationInfo>

## 2.8 Creator
## 2.8 Creator <a name="2.8"></a>

**2.8.1** Purpose: Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name. If the SPDX file was created on behalf of a company or organization, indicate the entity name. If the SPDX file was created using a software tool, indicate the name and version for that tool. If multiple participants or tools were involved, use multiple instances of this field. Person name or organization name may be designated as “anonymous” if appropriate.

Expand Down Expand Up @@ -270,7 +270,7 @@ Example:
<creator> Tool: LicenseFind-1.0 </creator>
</CreationInfo>

## 2.9 Created
## 2.9 Created <a name="2.9"></a>

**2.9.1** Purpose: Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard. This field is distinct from the fields in section 7, which involves the addition of information during a subsequent review.

Expand Down Expand Up @@ -305,7 +305,7 @@ Example:
<created> 2010-01-29T18:30:22Z </created>
</CreationInfo>

## 2.10 Creator Comment
## 2.10 Creator Comment <a name="2.10"></a>

**2.10.1** Purpose: An optional field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields.

Expand Down Expand Up @@ -333,7 +333,7 @@ Example:
and manual analysis by several authors of the code.</rdfs:comment>
</CreationInfo>

## 2.11 Document Comment
## 2.11 Document Comment <a name="2.11"></a>

**2.11.1** Purpose: An optional field for creators of the SPDX file content to provide comments to the consumers of the SPDX document.

Expand Down
Loading

0 comments on commit cfa1b9d

Please sign in to comment.