summaryrefslogtreecommitdiffstats
path: root/tests/auto/qtattributionsscanner
Commit message (Collapse)AuthorAgeFilesLines
* Merge remote-tracking branch 'origin/5.12' into 5.13Liang Qi2019-04-245-1/+8
|\ | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/qdoc/qmlmarkupvisitor.h src/qdoc/qmlvisitor.h tests/auto/qtattributionsscanner/testdata/good/expected.json Done-With: Kai Koehne <kai.koehne@qt.io> Change-Id: I180ee214d1e5999fc1279b092bd9214b6bf8f858
| * qtattributionsscanner: Add "PackageComment" fieldKai Koehne2019-03-255-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Extend qtattributionscanner to handle Chromium third-party contentNicolas Ettlin2018-10-022-0/+28
|/ | | | | | | | | | | qtattributionscanner is a tool used to generate the documentation for third-party modules at https://doc.qt.io/qt-5/licenses-used-in-qt.html. This commit makes qtattributionscanner parse README.chromium files, in addition to the qt_attribution.json files. Task-number: QTBUG-69285 Change-Id: Ie0e92a788efe28175387a62550ae0f32f26979f5 Reviewed-by: hjk <hjk@qt.io>
* Make the "Copyright" field in attribution files optionalNicolas Ettlin2018-07-241-1/+0
| | | | | | | | | | | | Currently, the "Copyright" field in copyright attribution files is mandatory. However, this obligation should be lifted so we could later use README.chromium files with the qtattributionscanner tool (these files do not contain a Copyright field ; in these cases, the copyright owners can be found in the license file's body). Change-Id: I569f8cd5d3f20fc85e5fcb873601053327841dda Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: hjk <hjk@qt.io>
* qtattributionsscanner: Make QDocModule, QtUsage entries optionalKai Koehne2018-06-011-2/+0
| | | | | | | | | | | For Qt modules these should really be filled, but they might not make sense in other contexts, like Qt for Python. Therefore make them optional. http://quips-qt-io.herokuapp.com/quip-0007.html should be adapted, too. Change-Id: Ic4837052f29df21291c4ffcde175e7ff0946d46a Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* qtattributionsscanner: Add test modeKai Koehne2018-04-037-8/+11
| | | | | | | | Rename test qt_attribution.json files to qt_attribution_test.json. This avoids warnings when picking up the test files in normal mode. Change-Id: I8831a81c84986c074d3519d2855c00987b4c2570 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* qtattributionsscanner: Allow to use it for one single fileKai Koehne2017-08-283-11/+54
| | | | | | | | | | | | | This allows a saner use with qbs, where we can and should actually handle the dependencies correctly. In addition, this patch adds an optional '--basedir' argument that is needed to correctly root relative paths that are printed in the documentation. Change-Id: I0abf769ad5c0a3ac15b6907f83b77d369eb78d1f GPush-Base: 5c8d5742dc7b5e00a6aed447e8f288680b58e225 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* qtattributionscanner: Support optional QtParts propertyKai Koehne2016-11-284-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | We'd like to differentiate between code that ends up in the Qt libraries or plugins, or code that only is added to examples, tests, or (host) tools. This can now be specified with the JSON property 'QtParts'. If 'QtParts' does not contain 'libs', the page will not show up in the list of attributions generated by module with e.g. \generatelist{groupsbymodule attributions-qtcore} nor in the global list generated by \generatelist annotatedattributions Instead, third party code in examples or tests can now be documented separately using e.g. \generatelist{groupsbymodule attributions-examples} and \annotatedlist attributions-examples Change-Id: Iba72f76b63e4435af54a61b7b4a2cf4617746ba6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* attributionscanner: Allow to specify multiple filesv5.8.0-beta1Kai Koehne2016-10-273-0/+4
| | | | | | | | | | So far 'Path' was used to specify a whole directory, or a single file. This introduces a separate 'Files' property, so that one can document that e.g. two specific files in a directory contain third party code. 'Files' should be relative to 'Path'. Change-Id: If4213d9a1b1ca706c49ed761027c6af86fbdc02a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qtattributionsscanner: Support setting & filtering qdoc moduleKai Koehne2016-08-087-0/+8
| | | | | | | | This is needed e.g. for qtbase, where there are multiple help projects. Change-Id: Ia31ac4818ad6780a301fa6f7371a3f33ee21df48 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Add qtattributionsscanner toolKai Koehne2016-08-0512-0/+252
qtattributionsscanner generates qdoc documentation about third party licenses in Qt sources. It scans recursively for qt_attribution.json files in the directory given on the command line. The qt_attribution.json file format is also documented under http://wiki.qt.io/Qt_attribution.json Task-number: QTBUG-55139 Change-Id: Ie8d9115beb9457c9f60a79e11c1c13dd19184d1c Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-10 21:54:39 +0000