diff options
author | Kai Koehne <kai.koehne@qt.io> | 2019-03-18 14:03:49 +0100 |
---|---|---|
committer | Kai Koehne <kai.koehne@qt.io> | 2019-03-25 13:59:42 +0000 |
commit | e9662ddd86f027bdbe617f5171cd63cae13b3845 (patch) | |
tree | 8ba70fd2476cfb19b0dd0b4f9aaf69ebedc58ec9 /tests | |
parent | 9c7502b0e5056da021ace0195e53d5b7b410120b (diff) |
qtattributionsscanner: Add "PackageComment" field
Add a new field that can be used for general purpose comments
about the package, not to be included in the generated qdoc
documentation.
JSON does not support comments as a first-class concept. A common
workaround is to use duplicated key entries, so that the first
one can be used as a comment field. Anyhow, this is arguably a
hack and not common knowledge.
The name is inspired by the "PackageComment" field in SPDX. The
new feature should already be made part of 5.12 so we can clean
up version information that recently became more prominently
visible as part of the qdoc title -
see https://doc.qt.io/qt-5/licenses-used-in-qt.html
Change-Id: Icfe843d1d725618114442687222c24122d0dd6b9
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Diffstat (limited to 'tests')
5 files changed, 7 insertions, 1 deletions
diff --git a/tests/auto/qtattributionsscanner/testdata/good/complete/qt_attribution_test.json b/tests/auto/qtattributionsscanner/testdata/good/complete/qt_attribution_test.json index f8e7b1c68..8035cefab 100644 --- a/tests/auto/qtattributionsscanner/testdata/good/complete/qt_attribution_test.json +++ b/tests/auto/qtattributionsscanner/testdata/good/complete/qt_attribution_test.json @@ -17,5 +17,6 @@ Usage", "Version": "1.0", "DownloadLocation": "www.qt.io/1.0", "LicenseId": "xxx", - "LicenseFile": "LICENSE" + "LicenseFile": "LICENSE", + "PackageComment": "just a test package" } diff --git a/tests/auto/qtattributionsscanner/testdata/good/expected.json b/tests/auto/qtattributionsscanner/testdata/good/expected.json index 2914dcc4b..89a727cd0 100644 --- a/tests/auto/qtattributionsscanner/testdata/good/expected.json +++ b/tests/auto/qtattributionsscanner/testdata/good/expected.json @@ -8,6 +8,7 @@ "LicenseFile": "%{PWD}/complete/LICENSE", "LicenseId": "xxx", "Name": "Complete", + "PackageComment":"just a test package", "Path": "%{PWD}/complete", "Files": "", "QDocModule": "qtest", @@ -25,6 +26,7 @@ "LicenseFile": "", "LicenseId": "", "Name": "Minimal", + "PackageComment":"", "Path": "%{PWD}/minimal", "Files": "", "QDocModule": "qtest", diff --git a/tests/auto/qtattributionsscanner/testdata/good/minimal/expected.json b/tests/auto/qtattributionsscanner/testdata/good/minimal/expected.json index 6a75269c0..8d9a5a31f 100644 --- a/tests/auto/qtattributionsscanner/testdata/good/minimal/expected.json +++ b/tests/auto/qtattributionsscanner/testdata/good/minimal/expected.json @@ -8,6 +8,7 @@ "LicenseFile": "", "LicenseId": "", "Name": "Minimal", + "PackageComment": "", "Path": "%{PWD}", "Files": "", "QDocModule": "qtest", diff --git a/tests/auto/qtattributionsscanner/testdata/warnings/incomplete/expected.json b/tests/auto/qtattributionsscanner/testdata/warnings/incomplete/expected.json index a28547bfe..fa56f2976 100644 --- a/tests/auto/qtattributionsscanner/testdata/warnings/incomplete/expected.json +++ b/tests/auto/qtattributionsscanner/testdata/warnings/incomplete/expected.json @@ -8,6 +8,7 @@ "LicenseFile": "", "LicenseId": "", "Name": "", + "PackageComment": "", "Path": "%{PWD}", "Files": "", "QDocModule": "", diff --git a/tests/auto/qtattributionsscanner/testdata/warnings/unknown/expected.json b/tests/auto/qtattributionsscanner/testdata/warnings/unknown/expected.json index 151af4093..18c1055f2 100644 --- a/tests/auto/qtattributionsscanner/testdata/warnings/unknown/expected.json +++ b/tests/auto/qtattributionsscanner/testdata/warnings/unknown/expected.json @@ -8,6 +8,7 @@ "LicenseFile": "", "LicenseId": "", "Name": "Unknown", + "PackageComment": "", "Path": "%{PWD}", "Files": "", "QDocModule": "qtest", |