Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.
Qt attribution.json: Difference between revisions
No edit summary |
No edit summary |
||
| Line 27: | Line 27: | ||
| '''License''' || The license under which the package is distributed, preferably with the names from [https://spdx.org/licenses/ SPDX] 'Full Name'. Mandatory. || Shown as text. | | '''License''' || The license under which the package is distributed, preferably with the names from [https://spdx.org/licenses/ SPDX] 'Full Name'. Mandatory. || Shown as text. | ||
|- | |- | ||
| LicenseId || [https://spdx.org/licenses/ SPDX] ID. Optional. || Shown as link (\l https://spdx.org/licenses/XXX) | | LicenseId || [https://spdx.org/licenses/ SPDX] ID. Optional. || Shown as link (\l https://spdx.org/licenses/XXX). | ||
|- | |- | ||
| LicenseFile || Relative path to file containing the license text. Optional. || Content is shown as text. | | LicenseFile || Relative path to file containing the license text. Optional. || Content is shown as text. | ||
| Line 35: | Line 35: | ||
= Example = | = Example = | ||
<nowiki> | |||
{ | |||
"Name": "SQLite 3.11.1.0", | |||
"ShortName": "sqlite", | |||
"QDocModule": "qtsql", | |||
"Description": "SQLite is a small C library that implements a self-contained, embeddable, zero-configuration SQL database engine. | |||
Configure with -system-sqlite or -no-sqlite to avoid.", | |||
"Usage": "Used in Qt SQL Lite plugin.", | |||
"Homepage": "http://www.sqlite.org/", | |||
"Version": "3.11.1.0", | |||
"Copyright": "The author disclaims copyright to this source code. However, a license can be obtained if needed.", | |||
"License": "Public Domain" | |||
} | |||
</nowiki> | |||
Revision as of 14:56, 19 July 2016
This is currently only a proposal.
qt_attribution.json 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. | \target and part of page name |
| QDocModule | The qch file the page should be part of. Mandatory. | - |
| Usage | Free text on where the 3rd party code in Qt is used, and how to avoid it (configure options?). Mandatory. | Shown as text. |
| Description | A short description of what the package is and is used for. Optional. | Shown as text. |
| Homepage | Homepage of the upstream project. Optional. | Shown as link. |
| Version | Version used from the upstream project. Optional. | Not used so far. |
| VersionLink | Link to exact upstream version. Optional. | Not used so far. |
| License | The license under which the package is distributed, preferably with the names from SPDX 'Full Name'. Mandatory. | Shown as text. |
| LicenseId | SPDX ID. Optional. | Shown as link (\l https://spdx.org/licenses/XXX). |
| LicenseFile | Relative path to file containing the license text. Optional. | Content is shown as text. |
| Copyright | (Aggregated) list of copyright lines. Mandatory. | Shown as text. |
Example
{ "Name": "SQLite 3.11.1.0", "ShortName": "sqlite", "QDocModule": "qtsql", "Description": "SQLite is a small C library that implements a self-contained, embeddable, zero-configuration SQL database engine. Configure with -system-sqlite or -no-sqlite to avoid.", "Usage": "Used in Qt SQL Lite plugin.", "Homepage": "http://www.sqlite.org/", "Version": "3.11.1.0", "Copyright": "The author disclaims copyright to this source code. However, a license can be obtained if needed.", "License": "Public Domain" }