Skip to content

Commit

Permalink
Update Relationship descriptions
Browse files Browse the repository at this point in the history
Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
  • Loading branch information
goneall authored and tsteenbe committed May 7, 2023
1 parent a8c5bd3 commit ea2e144
Showing 1 changed file with 38 additions and 38 deletions.
76 changes: 38 additions & 38 deletions model/Core/Vocabularies/RelationshipType.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,46 +20,46 @@ Build Profile specific RelationshipType descriptions can be found [here](https:/

## Entries

- amends: The `to` element(s) amends the `from` element
- ancestor: The `to` element(s) is an ancestor of the `from` element
- amends: Every `to` Element amends the `from` Element
- ancestor: Every `to` Element is an ancestor of the `from` Element
- availableFrom: This relationship is used to identify additional suppliers where an artifact is available from.
- 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: 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
- buildDependency: Every `to` Element 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: Every `to` Element is contained by the `from` Element
- copy: Every `to` Element is a copy of the `from` Element
- dataFile: Every `to` Element is a data file related to the the `from` Element
- dependencyManifest: Every `to` Element is manifest file containing dependency information related to the `from` Element
- dependsOn: Every `to` Element is a dependecy of the `from` Element
- descendant: This relationship may be used to describe child builds of a Build instance.
- 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
- describes: Every `to` Element 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: Every `to` Element is a development dependency for the `from` Element
- devTool: Every `to` Element is a development tool for the `from` Element
- distributionArtifact: Every `to` Element is an artifact intended for distribution of the `from` Element (e.g. an RPM or archive file)
- documentation: Every `to` Element is documentation for the `from` Element
- dynamicLink: Every `to` Element is dynamically linked to the `from` Element
- example: Every `to` Element is an example for the `from` Element
- expandedFromArchive: Every `to` Element is an artifact expanded from the `from` archive file
- fileAdded: Every `to` Element is is a file added to the `from` Element
- fileDeleted: Every `to` Element is a file deleted from the `from` Element
- fileModified: Every `to` Element is a modification of the `from` Element
- generates: Every `to` Element is generated from the `from` Element
- metafile: Every `to` Element is is a file containing metadata about the `from` Element
- optionalComponent: Every `to` Element is an optional component of the `from` Element
- optionalDependency: Every `to` Element is an optional dependency of the `from` Element
- other: Every `to` Element is related to the `from` Element where the relationship type is not described by any of the SPDX relationhip types
- packages: Every `to` Element is a packaged form of the `from` Element
- patch: Every `to` Element is a patch for the `from` Element
- prerequisite: Every `to` Element is a prerequisite of the `from` Element
- providedDependency: Every `to` Element is a dependency not included in the distributed artifact but is assumed to be provided the `from` Element
- requirementFor: Every `to` Element is required for the `from` Element
- runtimeDependency: Every `to` Element is a runtime dependency for the `from` Element
- specificationFor: Every `to` Element is a specification for the `from` Element
- staticLink: Every `to` Element is statically linked to the `from` Element
- test: Every `to` Element is a test artifact for the `from` Element
- testCase: Every `to` Element is a test case for the `from` Element
- testDependency: Every `to` Element is a test dependency for the `from` Element
- testTool: Every `to` Element is a test tool for the `from` Element
- variant: Every `to` Element 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
Expand Down

0 comments on commit ea2e144

Please sign in to comment.