Open-CMSIS-Pack
Version 1.7.44
Delivery Mechanism for Software Packs
|
The concept of licenseSets gets introduced to support pack content with a variety of governing license terms. A licenseSet is defined as a collection of one or more licenses. A license references an ASCII file located within the pack, containing the license terms.
Supported use cases:
Note, the licenseSets description section supersedes the file specified by the license element, if the tools supports licenseSets. The id attribute of a licenseSet is used to associate individual components and apis with a licenseSet.
Grouping element for licenseSets. No more than one such group can exist in a Pack. None is required.
Parent | Chain | ||
---|---|---|---|
package | /package | ||
Child Elements | Description | Type | Occurrence |
licenseSet | Description of a collection of license files | LicenseSetType | 1..* |
An element containing a list of one or more license files.
Parent | Chain | ||
---|---|---|---|
licenseSets | /package/licenseSets | ||
Attributes | Description | Type | Use |
id | license set identifier string which must be unique within the scope of the pdsc file. The id is used in components and apis to associate it with the licenseSet. | xs:string | required |
default | If set to 'true' this licenseSet is associated with the pack's content and for all apis and components, which are not explicitly referencing another licenseSet. There can only be a single default licenseSet. This optional attribute is treated as 'false' if not specified. | xs:boolean | optional |
gating | If set to 'true' this licenseSet is required to be accepted/acknowledged by the user before the installation process starts extracting any other files than license files from the pack. If declined the pack installation process will terminate. This optional attribute is treated as 'false' if not specified. | xs:boolean | optional |
Child Elements | Description | Type | Occurrence |
license | Description of a license file reference, unique identifier, title and default attributes | LicensefileType | 1..* |
An element describing an individual license file.
Parent | Chain | ||
---|---|---|---|
licenseSet | /package/licenseSets/licenseSet | ||
Attributes | Description | Type | Use |
name | license filename with pack base directory relative path. The license file is an ASCII text file with '*.txt' or no file extension | xs:string | required |
title | A display string used by tools to represent the license. | xs:string | required |
spdx | A machine readable license ID string according to the SPDX License List. In case a license is not listed here do not use this attribute. | xs:string | optional |
url | A public web link to the license text matching the file content referenced by name attribute. This url allows the inspection of license terms by the user prior to downloading the pack. | xs:anyURI | optional |