Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos, casing, and make SoftwarePurpose entry description consistent #885

Merged
merged 1 commit into from
Sep 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A process that takes data in any valid form (e.g., various serializations of SPD

## Class

A represention of a scope/set of individual instances of a particular “concept” (e.g., File, Person, ExternalReference, etc.).
A representation of a scope/set of individual instances of a particular “concept” (e.g., File, Person, ExternalReference, etc.).

Each individual instance of a class has an Internationalized Resource Identifier (IRI) and is asserted as a member of a particular class via a type statement.

Expand All @@ -25,7 +25,7 @@ One example could be the requirement of a specific hash algorithm to be present.

## Core

The namespace which contains definitions and constraints for all concpet classes and properties which are common to all other domains within the targeted scope of SPDX.
The namespace which contains definitions and constraints for all concept classes and properties which are common to all other domains within the targeted scope of SPDX.

## Datatype property

Expand Down
4 changes: 2 additions & 2 deletions model/Build/Build.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ In addition, the following Relationship Types may be used to describe a Build.
or host.
- configures: Describes the relationship from a configuration to the Build
element.
- ancestorOf: Describes a relationship from a Build element to Build eelements
- ancestorOf: Describes a relationship from a Build element to Build elements
that describe its child builds.
- decendentOf: Describes a relationship from a child Build element to its
- descendantOf: Describes a relationship from a child Build element to its
parent.
- usesTool: Describes a relationship from a Build element to a build tool.

Expand Down
2 changes: 1 addition & 1 deletion model/Build/Properties/buildType.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ elements, it means they are the same kind of build, but difference instances
and possible with different configurations.

If you are not using a well-known buildType, it should be namespaced to a
domain you own to prevent conflicts with other builtType IRIs.
domain you own to prevent conflicts with other buildType IRIs.

Examples of a buildType might be:

Expand Down
1 change: 0 additions & 1 deletion model/Core/Properties/dataLicense.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ and the identification of the supplier of SPDX files.
Compliance with this document includes populating the SPDX fields therein
with data related to such fields ("SPDX-Metadata").


This document contains numerous fields where an SPDX file creator may provide
relevant explanatory text in SPDX-Metadata. Without opining on the lawfulness
of "database rights" (in jurisdictions where applicable),
Expand Down
2 changes: 1 addition & 1 deletion model/Core/Properties/externalSpdxId.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ external to that SpdxDocument.

## Description

ExternalSpdxId identifies an external Element used within an SpdxDocument but
An externalSpdxId identifies an external Element used within an SpdxDocument but
defined external to that SpdxDocument.

## Metadata
Expand Down
2 changes: 1 addition & 1 deletion model/Core/Properties/hashValue.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The result of applying a hash algorithm to an Element.

## Description

HashValue is the result of applying a hash algorithm to an Element.
A hashValue is the result of applying a hash algorithm to an Element.

## Metadata

Expand Down
2 changes: 1 addition & 1 deletion model/Core/Properties/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Provides an ExternalMap of Element identifiers.

## Description

Import provides an ExternalMap of an Element identifier that is used within a
An import provides an ExternalMap of an Element identifier that is used within a
document but defined external to that document.

## Metadata
Expand Down
2 changes: 1 addition & 1 deletion model/Core/Properties/originatedBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Identifies from where or whom the Element originally came.

## Description

OriginatedBy identifies from where or whom the Element originally came.
An originatedBy identifies from where or whom the Element originally came.

## Metadata

Expand Down
2 changes: 1 addition & 1 deletion model/Core/Properties/spdxId.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Identifies an Element to be referenced by other Elements.

## Description

SpdxId uniquely identifies an Element which may thereby be referenced by other Elements.
An spdxId uniquely identifies an Element which may thereby be referenced by other Elements.
These references may be internal or external.
While there may be several versions of the same Element, each one needs to be able to be referred to uniquely
so that relationships between Elements can be clearly articulated.
Expand Down
2 changes: 1 addition & 1 deletion model/Core/Properties/verifiedUsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ asserted.

## Description

VerifiedUsing provides an IntegrityMethod with which the integrity of an
A verifiedUsing provides an IntegrityMethod with which the integrity of an
Element can be asserted.

Please note that different profiles may also provide additional methods for
Expand Down
2 changes: 1 addition & 1 deletion model/Core/Vocabularies/AnnotationType.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ AnnotationType specifies the type of an annotation.

## Entries

- other: Used to store extra information about an Element which is not part of a Review (e.g. extra information provided during the creation of the Element).
- other: Used to store extra information about an Element which is not part of a review (e.g. extra information provided during the creation of the Element).
- review: Used when someone reviews the Element.
2 changes: 1 addition & 1 deletion model/Core/Vocabularies/ExternalIdentifierType.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Specifies the type of an external identifier.

## Description

ExteralIdentifierType specifies the type of an external identifier.
ExternalIdentifierType specifies the type of an external identifier.

## Metadata

Expand Down
2 changes: 1 addition & 1 deletion model/Core/Vocabularies/RelationshipType.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ name completes the sentence:
- hasVariant: Every `to` Element is a variant the `from` Element (`from` hasVariant `to`).
- invokedBy: The `from` Element was invoked by the `to` Agent, during a LifecycleScopeType period (for example, a Build element that describes a build step).
- modifiedBy: The `from` Element is modified by each `to` 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 (this relationship is directionless).
- other: Every `to` Element is related to the `from` Element where the relationship type is not described by any of the SPDX relationship types (this relationship is directionless).
- packagedBy: Every `to` Element is a packaged instance of the `from` Element (`from` packagedBy `to`).
- patchedBy: Every `to` Element is a patch for the `from` Element (`from` patchedBy `to`).
- publishedBy: Designates a `from` Vulnerability was made available for public use or reference by each `to` Agent.
Expand Down
2 changes: 1 addition & 1 deletion model/Security/Properties/impactStatement.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ justification label.

When a VEX product element is related with a VexNotAffectedVulnAssessmentRelationship
and a machine readable justification label is not provided, then an impactStatement
that further explains how or why the prouct(s) are not affected by the vulnerability
that further explains how or why the product(s) are not affected by the vulnerability
must be provided.

## Metadata
Expand Down
2 changes: 1 addition & 1 deletion model/Software/Properties/additionalPurpose.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Provides additional purpose information of the software artifact.

## Description

Additional purpose provides information about the additional purposes of the
An additionalPurpose provides information about the additional purpose of the
software artifact in addition to the primaryPurpose.

## Metadata
Expand Down
2 changes: 1 addition & 1 deletion model/Software/Properties/sourceInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ about the origin of the package.

## Description

SourceInfo records any relevant background information or additional comments
A sourceInfo records any relevant background information or additional comments
about the origin of the package.

For example, this field might include comments indicating whether the package
Expand Down
58 changes: 29 additions & 29 deletions model/Software/Vocabularies/SoftwarePurpose.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,32 @@ conclusions about the context in which the Element exists.

## Entries

- application: the Element is a software application
- archive: the Element is an archived collection of one or more files (.tar, .zip, etc)
- bom: Element is a bill of materials
- configuration: Element is configuration data
- container: the Element is a container image which can be used by a container runtime application
- data: Element is data
- device: the Element refers to a chipset, processor, or electronic board
- diskImage: the Element refers to a disk image that can be written to a disk, booted in a VM, etc. A disk image typically contains most or all of the components necessary to boot, such as bootloaders, kernels, firmware, userspace, etc.
- deviceDriver: Element represents software that controls hardware devices
- documentation: Element is documentation
- evidence: the Element is the evidence that a specification or requirement has been fulfilled
- executable: Element is an Artifact that can be run on a computer
- file: the Element is a single file which can be independently distributed (configuration file, statically linked binary, Kubernetes deployment, etc)
- filesystemImage: the Element is a file system image that can be written to a disk (or virtual) partition
- firmware: the Element provides low level control over a device's hardware
- framework: the Element is a software framework
- install: the Element is used to install software on disk
- library: the Element is a software library
- manifest: the Element is a software manifest
- model: the Element is a machine learning or artificial intelligence model
- module: the Element is a module of a piece of software
- operatingSystem: the Element is an operating system
- other: the Element doesn't fit into any of the other categories
- patch: Element contains a set of changes to update, fix, or improve another Element
- platform: Element represents a runtime environment
- requirement: the Element provides a requirement needed as input for another Element
- source: the Element is a single or a collection of source files
- specification: the Element is a plan, guideline or strategy how to create, perform or analyse an application
- test: The Element is a test used to verify functionality on an software element
- application: The Element is a software application.
- archive: The Element is an archived collection of one or more files (.tar, .zip, etc.).
- bom: The Element is a bill of materials.
- configuration: The Element is configuration data.
- container: The Element is a container image which can be used by a container runtime application.
- data: The Element is data.
- device: The Element refers to a chipset, processor, or electronic board.
- diskImage: The Element refers to a disk image that can be written to a disk, booted in a VM, etc. A disk image typically contains most or all of the components necessary to boot, such as bootloaders, kernels, firmware, userspace, etc.
- deviceDriver: The Element represents software that controls hardware devices.
- documentation: The Element is documentation.
- evidence: The Element is the evidence that a specification or requirement has been fulfilled.
- executable: The Element is an Artifact that can be run on a computer.
- file: The Element is a single file which can be independently distributed (configuration file, statically linked binary, Kubernetes deployment, etc.).
- filesystemImage: The Element is a file system image that can be written to a disk (or virtual) partition.
- firmware: The Element provides low level control over a device's hardware.
- framework: The Element is a software framework.
- install: The Element is used to install software on disk.
- library: The Element is a software library.
- manifest: The Element is a software manifest.
- model: The Element is a machine learning or artificial intelligence model.
- module: The Element is a module of a piece of software.
- operatingSystem: The Element is an operating system.
- other: The Element doesn't fit into any of the other categories.
- patch: The Element contains a set of changes to update, fix, or improve another Element.
- platform: The Element represents a runtime environment.
- requirement: The Element provides a requirement needed as input for another Element.
- source: The Element is a single or a collection of source files.
- specification: The Element is a plan, guideline or strategy how to create, perform or analyze an application.
- test: The Element is a test used to verify functionality on an software element.