summaryrefslogtreecommitdiffstats
path: root/src/qtattributionsscanner
Commit message (Collapse)AuthorAgeFilesLines
* Add CMake target for qtattributionsscannerVolker Krause2019-06-042-0/+91
| | | | | | | | | Less useful for external users compared to qdoc, but neeeded for CMake builds of e.g. QtCreator and GammaRay. Change-Id: I8861cf30a21102309fef5b7bf3baf2707abf2965 Reviewed-by: Tobias Hunger <tobias.hunger@qt.io> Reviewed-by: Kevin Funk <kevin.funk@kdab.com>
* Merge remote-tracking branch 'origin/5.12' into 5.13Liang Qi2019-04-243-0/+5
|\ | | | | | | | | | | | | | | | | | | | | 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-253-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-02-191-2/+4
|\| | | | | | | Change-Id: If9dc5f167e9471b4633db73ae5a1cb8c1312b478
| * qtattributionsscanner: Add version to third-party component nameKai Koehne2019-02-121-2/+4
| | | | | | | | | | | | | | | | This is information important enough to show up in the title, and therefore also in the overview pages. Change-Id: I4bad7b46e186e34133a8a3cebe0c68cebec0e76c Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into devLiang Qi2019-01-041-1/+1
|\| | | | | | | | | | | | | | | | | Conflicts: src/qdoc/htmlgenerator.cpp src/qtattributionsscanner/qdocgenerator.cpp Done-With: Martin Smith <martin.smith@qt.io> Change-Id: I56a23175579a1a699939179da2f35bbcd6c73367
| * qtattributionsscanner: Always close a started documentation blockTopi Reinio2018-11-081-0/+1
| | | | | | | | | | | | | | | | | | | | | | If a license file referenced in a qt_attribution.json is not found, qtattributionsscanner must close the comment block before bailing out. Task-number: QTBUG-71646 Change-Id: I83ec4a457d0e2523ca70f8e8e1a99185329a46de Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* | Extend qtattributionscanner to handle Chromium third-party contentNicolas Ettlin2018-10-024-61/+202
|/ | | | | | | | | | | 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-3/+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-4/+1
| | | | | | | | | | | 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-031-1/+5
| | | | | | | | 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>
* Merge remote-tracking branch 'origin/5.9' into 5.105.10Liang Qi2018-02-021-0/+1
|\ | | | | | | | | | | | | Conflicts: src/qtattributionsscanner/main.cpp Change-Id: Ic509d457547ec64122b17511563de5ea3e1b1b44
| * qtattributionsscanner: Always write UTF-8 filesKai Koehne2018-01-231-0/+2
| | | | | | | | | | | | | | Both JSON and qdoc output files should be generated in UTF-8. Change-Id: I7d60d9042bcc1e8d69e164691fcc4129d4e95fb6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.10Liang Qi2017-11-151-1/+1
|\| | | | | | | | | | | | | Conflicts: src/qtattributionsscanner/main.cpp Change-Id: Idb919f217f1dea42728fd9318fd9f48d9c3d3f29
| * clazy: Fix clazy-detaching-temporaryFriedemann Kleint2017-11-041-1/+1
| | | | | | | | | | | | | | Fix in Qt Designer, pixeltool, qtattributionsscanner and qtpaths. Change-Id: Ideae055e8880552c1b8bf5a2a38326ac1356ffcb Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
* | qtattributionsscanner: Allow to use it for one single fileKai Koehne2017-08-283-14/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Remove declaration of non-existing methodKai Koehne2017-08-071-1/+0
| | | | | | | | | | Change-Id: I7848260ead4bf16fb922a061cb61291a0fec8df8 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Win: Set proper descriptions for toolsKai Koehne2017-07-261-0/+1
|/ | | | | | | | | | | | | | | This is shown in the file properties and in crash dialogs. Because of the latter, a short name is better than a description, otherwise you get dialogs like Tool for viewing on-line documentation in Qt help file format has stopped working. Task-number: QTBUG-61970 Change-Id: I9289fe9546a6d9056bbfddb2b6c0bb0ae94684c2 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Cleanup QRegExp includesSamuel Gaist2017-03-071-0/+1
| | | | | | | | | | This patch adds the missing QRegExp includes in prevision of the qtbase include cleanup. Change-Id: I25b66ac2cf71bdfa74612aa9dcd35ae9d0584f17 Reviewed-by: André Hartmann <aha_1980@gmx.de> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
* qtattributionsscanner: Fix warning about comparing enumsFriedemann Kleint2017-02-161-1/+1
| | | | | | | scanner.cpp:94:44: warning: comparison between 'enum QVariant::Type' and 'enum QMetaType::Type' [-Wenum-compare] Change-Id: Id81c72de244da6b6df8df91063df9f43fb588ddd Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Merge remote-tracking branch 'origin/5.8' into devLiang Qi2017-01-251-1/+1
|\ | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: Ide38734b7f27b855ed8fecb810e5cdc7d518110e
| * move project file statements to canonical locationsOswald Buddenhagen2017-01-191-1/+1
| | | | | | | | | | | | | | | | load(qt_app) belongs at the end of the project file, while option(host_build) at the top. Change-Id: Icaa80e6436d84eee91f6ccf91051c139e80a0b64 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | foreach cleanup in the the smaller toolsFriedemann Kleint2016-12-222-3/+4
|/ | | | | | | | | Replace foreach by C++ 11 range based for in kmap2qmap, makeqpf, pixeltool, qdbus, qtattributionsscanner, qtdiag, qtplugininfo, winrtrunner and the simpletextviewer example. Change-Id: I079da84c47a1584526f4fe188377c0262419a44d Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
* qtattributionscanner: Support optional QtParts propertyKai Koehne2016-11-284-4/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* qtattributionscanner: Print (and link to) upstream version in qdoc outputKai Koehne2016-11-181-2/+17
| | | | | Change-Id: I3f50456cee9a11e41e200a097ba2152d94ee273a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* attributionscanner: Allow to specify multiple filesv5.8.0-beta1Kai Koehne2016-10-274-4/+35
| | | | | | | | | | 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: Fix MSVC compiler warningFriedemann Kleint2016-10-211-2/+3
| | | | | | | packagefilter.cpp(38): warning C4267: 'argument': conversion from 'size_t' to 'int', possible loss of data Change-Id: Ief4aad17ef27202cc00fe9de987ca30f4acbc2a7 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Put attribution files into module namespaceKai Koehne2016-10-201-2/+2
| | | | | Change-Id: I9e3b6d1a212ce85191e99e143a0a571ac5915d4c Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* qtattributionscanner: Ignore licenseId's with spacesKai Koehne2016-10-111-1/+16
| | | | | | | | | SPDX license expressions can contain more elaborate structs with AND and OR operators. Just ignore these for now in the .qdoc generation step. Change-Id: I9bcd432ebd6a188a1745432ddd3aa5b3bbd48b03 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Make qtattributionscanner a qt_toolKai Koehne2016-10-061-1/+1
| | | | | | | | This should fix cross-compiling problems when building Qt for iOS. Change-Id: Id7812120a2729261542ef770395a2b2861d582ba Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
* qtattributionscanner: Do not use system separators for file paths in qdocKai Koehne2016-09-151-1/+1
| | | | | | | | | The documentation should be independent from the platform it's generated on. This also fixes lots of qdoc warnings because backslashes on Windows were not properly escaped. Change-Id: Ie7d6842af029d2ad15d6215f059e7fcf36c24e3f Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* qtattributionsscanner: Support setting & filtering qdoc moduleKai Koehne2016-08-088-2/+126
| | | | | | | | This is needed e.g. for qtbase, where there are multiple help projects. Change-Id: Ia31ac4818ad6780a301fa6f7371a3f33ee21df48 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* qtattributionsscanner: Use new qdoc attribution attributeKai Koehne2016-08-081-1/+1
| | | | | Change-Id: Ibb720811808053b76a794b3333cb2a698b961281 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Add qtattributionsscanner toolKai Koehne2016-08-0510-0/+728
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-19 10:17:22 +0000