Skip to content

Commit

Permalink
Add Package Purpose field
Browse files Browse the repository at this point in the history
Fixes spdx#621

Signed-off-by: Nisha K <[email protected]>
  • Loading branch information
Nisha K authored and nishakm committed Apr 1, 2022
1 parent ceaf215 commit 1026215
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions chapters/package-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -1417,6 +1417,54 @@ EXAMPLE 2 RDF: Property `spdx:attributionText` in class `spdx:Package`
</Package>
```

## 7.24 Package Purpose field <a name="7.24"></a>

### 7.24.1 Description

This field provides information about the purpose of the identified package. Package Purpose is intrinsic to how the package is being used rather than the content of the package. The options to populated this field are limited to:

`APPLICATION` if the package is a software application;
`FRAMEWORK` if the package is a software framework;
`LIBRARY` if the package is a software library;
`CONTAINER` if the package refers to a container image which can be used by a container runtime application;
`OPERATING-SYSTEM` if the package refers to an operating system;
`DEVICE` if the package refers to a chipset, processor, or electronic board;
`FIRMWARE` if the package provides low level control over a device's hardware;
`SOURCE` if the package is a collection of source files;
`ARCHIVE` if the package refers to an archived collection of files (.tar, .zip, etc);
`FILE` if the package is a single file which can be independently distributed (configuration file, statically linked binary, Kubernetes deployment, etc);
`OTHER` if the package doesn't fit into the above categories.

The metadata for the Package Purpose field is shown in Table 36.

**Table 36 — Metadata for the package purpose field**

| Attribute | Value |
| --------- | ----- |
| Required | No |
| Cardinality | 0..* |
| Format | `APPLICATION` \| `FRAMEWORK` \| `LIBRARY` \| `CONTAINER` \| `OPERATING-SYSTEM` \| `DEVICE` \| `FIRMWARE` \| `SOURCE` \| `ARCHIVE` \| `FILE` \| `OTHER` \|

### 7.24.2 Intent

This field is a reasonable estimate of the package usage from the producer and consumer perspective from which both parties can draw conclusions about the context in which the package exists.

### 7.24.3 Examples

EXAMPLE 1 Tag: `PackagePurpose:`

```text
PackagePurpose: FRAMEWORK
```

EXAMPLE 2 RDF: Property `spdx:purpose` in class `spdx:Package`

```text
<Package rdf:about="cluster-api">
<packagePurpose rdf:resource="packagePurpose_container" />
</Package>
```

[Bazaar]: http://bazaar.canonical.com/
[FSF]: http://www.fsf.org/
[Git]: https://git-scm.com/
Expand Down

0 comments on commit 1026215

Please sign in to comment.