Add comments for relationships

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
spdx · May 7, 2023 · a8c5bd3 · a8c5bd3
1 parent 1927ab0
commit a8c5bd3
Showing 1 changed file with 37 additions and 37 deletions.
diff --git a/model/Core/Vocabularies/RelationshipType.md b/model/Core/Vocabularies/RelationshipType.md
@@ -20,46 +20,46 @@ Build Profile specific RelationshipType descriptions can be found [here](https:/
 
 ## Entries
 
-- amends: TODOdescription
-- ancestor: TODOdescription
+- amends: The `to` element(s) amends the `from` element
+- ancestor: The `to` element(s) is an ancestor of the `from` element
 - availableFrom:  This relationship is used to identify additional suppliers where an artifact is available from.
-- buildDependency: TODOdescription
+- buildDependency: The `to` element(s) is a build dependency of the `from` element
 - buildTool: Build tool used to build an element. This may be used to describe the build tool of a Build instance.
-- contains: TODOdescription
-- copy: TODOdescription
-- dataFile: TODOdescription
-- dependencyManifest: TODOdescription
-- dependsOn: TODOdescription
+- contains: The `to` element(s) is contained by the `from` element
+- copy: The `to` element(s) is a copy of the `from` element
+- dataFile: The `to` element(s) is a data file related to the the `from` element
+- dependencyManifest: The `to` element(s) is manifest file containing dependency information related to the `from` element
+- dependsOn: The `to` element(s) is a dependecy of the `from` element
 - descendant: This relationship may be used to describe child builds of a Build instance.
-- describes: TODOdescription
-- devDependency: TODOdescription
-- devTool: TODOdescription
-- distributionArtifact: TODOdescription
-- documentation: TODOdescription
-- dynamicLink: TODOdescription
-- example: TODOdescription
-- expandedFromArchive: TODOdescription
-- fileAdded: TODOdescription
-- fileDeleted: TODOdescription
-- fileModified: TODOdescription
-- generates: TODOdescription
-- metafile: TODOdescription
-- optionalComponent: TODOdescription
-- optionalDependency: TODOdescription
-- other: TODOdescription
-- packages: TODOdescription
-- patch: TODOdescription
-- prerequisite: TODOdescription
-- providedDependency: TODOdescription
-- requirementFor: TODOdescription
-- runtimeDependency: TODOdescription
-- specificationFor: TODOdescription
-- staticLink: TODOdescription
-- test: TODOdescription
-- testCase: TODOdescription
-- testDependency: TODOdescription
-- testTool: TODOdescription
-- variant: TODOdescription
+- describes: The `to` element(s) is  described by the `from` element.  This can be used to denote the root(s) of a tree of elements contained in an SBOM.
+- devDependency: The `to` element(s) is a development depenency for the `from` element
+- devTool: The `to` element(s) is a development tool for the `from` element
+- distributionArtifact: The `to` element(s) is an artifact intended for distribution of the `from` element (e.g. an RPM or archive file)
+- documentation: The `to` element(s) is documentation for the `from` element
+- dynamicLink: The `to` element(s) is dynamically linked to the `from` element
+- example: The `to` element(s) is an example for the `from` element
+- expandedFromArchive: The `to` element(s) is an artifact expanded from the `from` archive file
+- fileAdded: The `to` element(s) is is a file added to the `from` element
+- fileDeleted: The `to` element(s) is a file deleted from the `from` element
+- fileModified: The `to` element(s) is a modification of the `from` element
+- generates: The `to` element(s) is generated from the `from` element
+- metafile: The `to` element(s) is is a file containing metadata about the `from` element
+- optionalComponent: The `to` element(s) is an optional component of the `from` element
+- optionalDependency: The `to` element(s) is an optional dependency of the `from` element
+- other: The `to` element(s) is related to the `from` element where the relationship type is not described by any of the SPDX relationhip types
+- packages: The `to` element(s) is a packged form of the `from` element
+- patch: The `to` element(s) is a patch for the `from` element
+- prerequisite: The `to` element(s) is a prerequisite of the `from` element
+- providedDependency: The `to` element(s) is a dependency not included in the distributed artifact but is assumed to be provided the `from` element
+- requirementFor: The `to` element(s) is required for the `from` element
+- runtimeDependency: The `to` element(s) is a runtime dependency for the `from` element
+- specificationFor: The `to` element(s) is a specification for the `from` element
+- staticLink: The `to` element(s) is statically linked to the `from` element
+- test: The `to` element(s) is a test artifact for the `from` element
+- testCase: The `to` element(s) is a test case for the `from` element
+- testDependency: The `to` element(s) is a test dependency for the `from` element
+- testTool: The `to` element(s) is a test tool for the `from` element
+- variant: The `to` element(s) is a variant the `from` element
 - buildInputOf: Input to the build instance
 - buildOutputOf: Output of the build instance
 - buildConfigOf: Build configuration of the build instance