AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CMake: Document convenience scripts in README

Browse Source 
Change-Id: I7ec7f01f744285fc086de8a0430afbf49563adce
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
This commit is contained in:
Joerg Bornemann 2020-10-06 15:22:10 +02:00
parent 539cd49cee
commit 9ef4411d81
1 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
cmake/README.md
View File

@ -252,3 +252,48 @@ While the supporting code for building with vcpkg is still there, it is not test
| ``qtHaveModule(foo)`` | ``if(TARGET Qt::foo)`` |
| ``qtConfig(foo)`` | ``if (QT_FEATURE_foo)`` |
# Convenience Scripts
A Qt installation's bin directory contains a number of convenience scripts.
## qt-cmake
This is a wrapper around the CMake executable which passes a Qt-internal `CMAKE_TOOLCHAIN_FILE`. Use
this to build projects against the installed Qt.
## qt-cmake-private
The same as `qt-cmake`, but in addition, sets the CMake generator to Ninja.
Example:
```
$ cd some/empty/directory
$ ~/Qt/6.0.0/bin/qt-cmake-private ~/source/of/qtdeclarative -DFEATURE_qml_network=OFF
$ cmake --build . && cmake --install .
```
## qt-configure-module
Call the configure script for a single Qt module, doing a CMake build.
Example:
```
$ cd some/empty/directory
$ ~/Qt/6.0.0/bin/qt-configure-module ~/source/of/qtdeclarative -no-feature-qml-network
$ cmake --build . && cmake --install .
```
## qt-cmake-standalone-test
Build a single standalone test outside the Qt build.
Example:
```
$ cd some/empty/directory
$ ~/Qt/6.0.0/bin/qt-cmake-standalone-test ~/source/of/qtbase/test/auto/corelib/io/qprocess
$ cmake --build .
```