Qt attribution.json
Jump to navigation
Jump to search
This is currently only a proposal.
COPYRIGHT.qt files are used to document 3rd party code inside the Qt modules. It is a JSON based format that can be processed with the licensescanner tool.
Content
| Name | Description | Usage in qdoc |
|---|---|---|
| name | Descriptive name of the package, without version number. Camel case. Mandatory. | Title |
| shortName | Unique name for package, without spaces. All lower case. Mandatory. | Link target |
| description | A short description of what the package is and is used for. Optional. | |
| modules | Space separated list of modules where the code is used. Mandatory. | Link target |
| usage | Free text on where the 3rd party code in Qt is used, and how to avoid it (configure options?). Mandatory. | |
| homepage | Homepage of the upstream project. Optional. | |
| version | Version used from the upstream project. Optional. | |
| versionLink | Link to exact upstream version. Optional. | |
| license | The license under which the package is distributed, preferably with the names from SPDX 'Full Name'. Mandatory. | |
| licenseId | SPDX ID. Optional. | |
| licenseFile | Relative path to file containing the license text. Optional. | |
| copyright | (Aggregated) list of copyright lines. Optional. |