Add a licenseRule.json file for checking of SPDX license identifiers
The license test in qtqa reads this file in order to check the validity of the license used. This file reproduce the QUIP-18 [1] rules, with some exceptions. Each entry in the file corresponds to a set of licensing rules. A set of licensing rules can depend on the file ending, registered in "file_pattern_ending". The last entry in the file has no "file_pattern_ending", it sets the rules for the files whose licensing does not depend on their ending. The license to be used depends on the location of the file within the Qt module repository. Let's call this "<true_location>". The "<true_location>" can also correspond to a file name, offering flexibility for exceptions to the rule. The "<true_location>" are registered in "location". For each "<true_location>" there is a "file type" entry and a "spdx" entry. The "spdx" entry gives the rule: the expected license tag(s) in SPDX format for the file ending (if applicable) and "<true_location>". The "file type" informs on the QUIP-18 type the tested file corresponds to. It is purely informational for the reader. The set of rules are tested in order of appearance in the json file. For this reason, a more constraining ending (like "special.txt") needs to appear in a "file_pattern_ending" located before the "file_pattern_ending" of a less constraining ending (like ".txt"). Also, a file ending cannot be present in two "file_pattern_ending". "file_pattern_ending" and "spdx" should list strings. "<true_location>" can be regular expressions. During the test the deeper "<true_location>" are checked first. The order is which they appear in the json file does not matter. To test this file, run QT_MODULE_TO_TEST=../qtbase perl tests/prebuild/license/tst_licenses.pl [1]: https://contribute.qt-project.org/quips/18 Task-number: QTBUG-121039 Change-Id: I720800507622701b80c76e78e68817c6c39c2407 Reviewed-by: Kai Köhne <kai.koehne@qt.io> (cherry picked from commit d5d1bfd8e87a718145d1d8e3161fdf44ed1a804b) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Lucie Gérard
Qt Cherry-pick Bot
parent
60d91acc0a
commit
f3a66b2763
179
licenseRule.json
Normal file
179
licenseRule.json
Normal file
@ -0,0 +1,179 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"comment" : ["file_pattern_ending: strings matched against the end of a file name.",
|
||||||
|
"location keys: regular expression matched against the beginning of",
|
||||||
|
"the file path (relative to the git submodule root).",
|
||||||
|
"spdx: list of SPDX-License-Expression's allowed in the matching files.",
|
||||||
|
"-------------------------------------------------------",
|
||||||
|
"Files with the following endings are Build System licensed,",
|
||||||
|
"unless they are examples",
|
||||||
|
"Files with other endings can also be build system files"
|
||||||
|
],
|
||||||
|
"file_pattern_ending" : ["CMakeLists.txt", ".cmake", ".pro", ".pri", ".prf",
|
||||||
|
"configure", "configure.bat", "cmake.in", "plist.in", "CMakeLists.txt.in"],
|
||||||
|
"location" : {
|
||||||
|
"" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "build system",
|
||||||
|
"spdx" : ["BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"(.*)(examples/|snippets/)" : {
|
||||||
|
"comment" : "Example takes precedent",
|
||||||
|
"file type" : "examples and snippets",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"tests/auto/cmake/test_plugin_shared_static_flavor.cmake" : {
|
||||||
|
"comment" : "Exception. This is a test file.",
|
||||||
|
"file type" : "test",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"comments" : ["Files with the following endings are Tool licensed,",
|
||||||
|
"unless they are examples.",
|
||||||
|
"Files with other endings can also be tool files."],
|
||||||
|
"file_pattern_ending" : [".sh", ".py", ".pl", ".bat", ".ps1"],
|
||||||
|
"location" :{
|
||||||
|
"" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "tools and utils",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0"]
|
||||||
|
},
|
||||||
|
"(.*)(examples/|snippets/)" : {
|
||||||
|
"comment" : "Example takes precedent",
|
||||||
|
"file type" : "examples and snippets",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"tests/auto/tools/uic/baseline/config.ui.py" : {
|
||||||
|
"comment" : "This is a test file",
|
||||||
|
"file type" : "test",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"comment" : "Files with the following endings are Documentation licensed.",
|
||||||
|
"file_pattern_ending" : [".qdoc", ".qdocinc" , ".qdocconf", ".txt", "README", "qt_attribution.json"],
|
||||||
|
"location" :{
|
||||||
|
"" : {
|
||||||
|
"comment" : "",
|
||||||
|
"file type" : "documentation",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only"]
|
||||||
|
},
|
||||||
|
"tests/auto/corelib/mimetypes/qmimedatabase/test.txt" : {
|
||||||
|
"comment" : "Exception. This is a test file",
|
||||||
|
"file type" : "test",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"comment" : ["All other files",
|
||||||
|
"The licensing is defined only by the file location in the Qt module repository.",
|
||||||
|
"NO <file_pattern_ending> key for this case!",
|
||||||
|
"This needs to be the last entry of the file."],
|
||||||
|
"location" : {
|
||||||
|
"" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"src/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"plugins/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "module and plugin ",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"src/plugins/platforms/wasm/" : {
|
||||||
|
"comment" : "Exception for wasm",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"src/dbus/dbus_minimal_p.h" : {
|
||||||
|
"comment" : "Exception",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["AFL-2.1 OR GPL-2.0-or-later"]
|
||||||
|
},
|
||||||
|
"src/entrypoint/qtentrypoint_win.cpp" : {
|
||||||
|
"comment" : "Exception: https://doc.qt.io/qt-6/qtentrypoint.html",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"src/android/java/src/org/qtproject/qt/android/bindings/" : {
|
||||||
|
"comment" : "Exception: compiled alongside with user code",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"src/tools/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "tools and utils",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0"]
|
||||||
|
},
|
||||||
|
"tests/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "test",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"cmake/qbatchedtestrunner.in.cpp" : {
|
||||||
|
"comment" : "Compiled into internal tests if QT_BUILD_TESTS_BATCHED is enabled.",
|
||||||
|
"file type" : "test",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"tests/auto/testlib/selftests/catch_p_p.h" : {
|
||||||
|
"comment" : "Exception",
|
||||||
|
"file type" : "test",
|
||||||
|
"spdx" : ["BSL-1.0"]
|
||||||
|
},
|
||||||
|
"(.*)(examples/|snippets/)" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "examples and snippets",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"config.tests/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "build system",
|
||||||
|
"spdx" : ["BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"config.tests/no_direct_extern_access/" : {
|
||||||
|
"comment" : "Exception",
|
||||||
|
"file type" : "build system",
|
||||||
|
"spdx" : ["MIT"]
|
||||||
|
},
|
||||||
|
"src/corelib/Qt6CoreResourceInit.in.cpp" : {
|
||||||
|
"comment" : "Helper file statically compiled into user executables",
|
||||||
|
"file type" : "module and plugin",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
},
|
||||||
|
"qmake/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "tools and utils",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0"]
|
||||||
|
},
|
||||||
|
"util/" : {
|
||||||
|
"comment" : "Default",
|
||||||
|
"file type" : "util",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0"]
|
||||||
|
},
|
||||||
|
"util/wasm/batchedtestrunner/" : {
|
||||||
|
"comment" : "Exception: this is a helper tool",
|
||||||
|
"file type" : "util",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0"]
|
||||||
|
},
|
||||||
|
"util/x86simdgen/header" : {
|
||||||
|
"comment" : "Exception for file generation",
|
||||||
|
"file type" : "util",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only"]
|
||||||
|
},
|
||||||
|
"util/glgen/qopenglextensions.(h|cpp).header" : {
|
||||||
|
"comment" : "Exception, for file generation",
|
||||||
|
"file type" : "util",
|
||||||
|
"spdx" : ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
Loading…
x
Reference in New Issue
Block a user