2020-07-01 17:42:07 +02:00
|
|
|
The following table describes the mapping of configure options to CMake arguments.
|
|
|
|
|
|
|
|
|
|
| configure | cmake | Notes |
|
|
|
|
|
|---------------------------------------|---------------------------------------------------|-----------------------------------------------------------------|
|
|
|
|
|
| -prefix /opt/qt6 | -DCMAKE_INSTALL_PREFIX=/opt/qta6 | |
|
2022-02-22 18:51:16 +01:00
|
|
|
| -no-prefix (only available in Qt6) | -DCMAKE_INSTALL_PREFIX=$PWD (with bash) | In Qt5 this was done by specifying -prefix $PWD |
|
|
|
|
|
| or -DFEATURE_no_prefix=ON | |
|
2020-07-01 17:42:07 +02:00
|
|
|
| -extprefix /opt/qt6 | -DCMAKE_STAGING_PREFIX=/opt/qt6 | |
|
|
|
|
|
| -bindir <dir> | -DINSTALL_BINDIR=<dir> | similar for -headerdir -libdir and so on |
|
2020-11-10 15:31:55 +01:00
|
|
|
| -hostdatadir <dir> | -DINSTALL_MKSPECSDIR=<dir> | |
|
2024-03-07 15:32:00 +08:00
|
|
|
| -qt-host-path <dir> | -DQT_HOST_PATH=<dir> | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -help | n/a | Handled by configure[.bat]. |
|
2022-04-05 15:13:38 +02:00
|
|
|
| -verbose | --log-level=STATUS | Sets the CMake log level to STATUS. The default one is NOTICE. |
|
2020-07-01 17:42:07 +02:00
|
|
|
| -continue | | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -redo | n/a | Handled by configure[.bat]. |
|
2020-07-01 17:42:07 +02:00
|
|
|
| -recheck [test,...] | | |
|
|
|
|
|
| -feature-foo | -DFEATURE_foo=ON | |
|
|
|
|
|
| -no-feature-foo | -DFEATURE_foo=OFF | |
|
|
|
|
|
| -list-features | | At the moment: configure with cmake once, |
|
|
|
|
|
| | | then use ccmake or cmake-gui to inspect the features. |
|
2020-10-13 11:56:49 +02:00
|
|
|
| -opensource | n/a | |
|
|
|
|
|
| -commercial | n/a | |
|
|
|
|
|
| -confirm-license | n/a | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -release | -DCMAKE_BUILD_TYPE=Release | |
|
|
|
|
|
| -debug | -DCMAKE_BUILD_TYPE=Debug | |
|
|
|
|
|
| -debug-and-release | -G "Ninja Multi-Config" | |
|
|
|
|
|
| | -DCMAKE_CONFIGURATION_TYPES=Release;Debug | |
|
2020-08-20 15:19:07 +02:00
|
|
|
| -optimize-debug | -DFEATURE_optimize_debug=ON | |
|
2020-08-21 08:40:54 +02:00
|
|
|
| -optimize-size | -DFEATURE_optimize_size=ON | |
|
2020-08-20 15:19:07 +02:00
|
|
|
| -optimized-tools | n/a | This affects only host tools. |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -force-debug-info | Use the RelWithDebInfo build config. | |
|
|
|
|
|
| -separate-debug-info | -DFEATURE_separate_debug_info=ON | |
|
2020-08-21 09:22:23 +02:00
|
|
|
| -gdb-index | -DFEATURE_enable_gdb_index=ON | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -strip | cmake --install . --strip | This affects the install targets generated by qmake. |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -gc-binaries | -DFEATURE_gc_binaries=ON | |
|
2020-08-24 10:39:49 +02:00
|
|
|
| -force-asserts | -DFEATURE_force_asserts=ON | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -developer-build | -DFEATURE_developer_build=ON | |
|
|
|
|
|
| -shared | -DBUILD_SHARED_LIBS=ON | |
|
|
|
|
|
| -static | -DBUILD_SHARED_LIBS=OFF | |
|
|
|
|
|
| -framework | -DFEATURE_framework=ON | |
|
|
|
|
|
| -platform <target> | -DQT_QMAKE_TARGET_MKSPEC=<mkspec> | |
|
2020-10-08 19:32:16 +02:00
|
|
|
| -xplatform <target> | -DQT_QMAKE_TARGET_MKSPEC=<mkspec> | Used for generating qmake-compatibility files. |
|
|
|
|
|
| | | If passed 'macx-ios-clang', will configure an iOS build. |
|
2020-07-01 17:42:07 +02:00
|
|
|
| -device <name> | equivalent to -xplatform devices/<name> | |
|
|
|
|
|
| -device-option <key=value> | -DQT_QMAKE_DEVICE_OPTIONS=key1=value1;key2=value2 | Only used for generation qmake-compatibility files. |
|
|
|
|
|
| | | The device options are written into mkspecs/qdevice.pri. |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -appstore-compliant | -DFEATURE_appstore_compliant=ON | |
|
2024-10-14 17:05:23 +02:00
|
|
|
| -sbom | -DQT_GENERATE_SBOM=ON | Enables generation and installation of a SPDX SBOM documents |
|
|
|
|
|
| -sbom-json | -DQT_SBOM_GENERATE_JSON=ON | Enables generation of SPDX SBOM in JSON format |
|
|
|
|
|
| -sbom-json-required | -DQT_SBOM_REQUIRE_GENERATE_JSON=ON | Fails the build if Python deps are not found |
|
|
|
|
|
| -sbom-verify | -DQT_SBOM_VERIFY=ON | Enables verification of generated SBOMs |
|
|
|
|
|
| -sbom-verify-required | -DQT_SBOM_REQUIRE_VERIFY=ON | Fails the build if Python deps are not found |
|
2025-02-19 16:29:10 +01:00
|
|
|
| -sbomdir <dir> | -DINSTALL_SBOMDIR=<dir> | Installation location of SBOM files. |
|
2024-03-05 11:31:09 +01:00
|
|
|
| -qtinlinenamespace | -DQT_INLINE_NAMESPACE=ON | Make the namespace specified by -qtnamespace an inline one. |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -qtnamespace <name> | -DQT_NAMESPACE=<name> | |
|
2020-09-21 15:45:28 +02:00
|
|
|
| -qtlibinfix <infix> | -DQT_LIBINFIX=<infix> | |
|
2023-09-13 16:31:52 +02:00
|
|
|
| -coverage <tool> | -DINPUT_coverage=<tool> | Enables code coverage using the specified tool. |
|
|
|
|
|
| -gcov | -DINPUT_coverage=gcov | Enables code coverage using the gcov tool. |
|
2020-08-24 21:05:05 +02:00
|
|
|
| -trace [backend] | -DINPUT_trace=yes or -DINPUT_trace=<backend> | |
|
|
|
|
|
| | or -DFEATURE_<backend> | |
|
2025-03-05 11:51:28 +01:00
|
|
|
| -sanitize address | -DFEATURE_sanitize_address=ON | Directly setting -DECM_ENABLE_SANITIZERS=foo is not supported |
|
|
|
|
|
| -sanitize undefined | -DFEATURE_sanitize_undefined=ON | See above. |
|
|
|
|
|
| -sanitize thread | -DFEATURE_sanitize_thread=ON | See above. |
|
|
|
|
|
| -sanitize memory | -DFEATURE_sanitize_memory=ON | See above. |
|
2021-02-09 13:12:09 +01:00
|
|
|
| -c++std c++20 | -DFEATURE_cxx20=ON | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -sse2/-sse3/-ssse3/-sse4.1 | -DFEATURE_sse4=ON | |
|
|
|
|
|
| -mips_dsp/-mips_dspr2 | -DFEATURE_mips_dsp=ON | |
|
2020-08-18 10:59:03 +02:00
|
|
|
| -qreal <type> | -DQT_COORD_TYPE=<type> | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -R <string> | -DQT_EXTRA_RPATHS=path1;path2 | |
|
|
|
|
|
| -rpath | negative CMAKE_SKIP_BUILD_RPATH | |
|
|
|
|
|
| | negative CMAKE_SKIP_INSTALL_RPATH | |
|
2023-01-05 15:59:44 +01:00
|
|
|
| | negative CMAKE_MACOSX_RPATH | |
|
2020-08-25 08:17:23 +02:00
|
|
|
| -reduce-exports | -DFEATURE_reduce_exports=ON | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -reduce-relocations | -DFEATURE_reduce_relocations=ON | |
|
2020-07-01 17:42:07 +02:00
|
|
|
| -plugin-manifests | | |
|
2020-07-02 11:25:28 +02:00
|
|
|
| -static-runtime | -DFEATURE_static_runtime=ON | |
|
|
|
|
|
| -pch | -DBUILD_WITH_PCH=ON | |
|
2020-08-27 14:11:00 +02:00
|
|
|
| -ltcg | -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=ON or | |
|
|
|
|
|
| | -DCMAKE_INTERPROCEDURAL_OPTIMIZATION_<CONFIG>=ON | |
|
2022-03-29 23:18:34 +09:00
|
|
|
| -linker [bfd,gold,lld,mold] | -DINPUT_linker=<name> or | |
|
2020-08-20 09:06:16 +02:00
|
|
|
| | -DFEATURE_use_<name>_linker=ON | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -incredibuild-xge | n/a | This option enables remote distribution of Visual Studio |
|
|
|
|
|
| | | custom build steps for moc, uic, and rcc. |
|
|
|
|
|
| | | This lacks support in CMake. |
|
2020-07-01 17:42:07 +02:00
|
|
|
| -ccache | -DQT_USE_CCACHE=ON | |
|
2023-02-08 12:08:37 +01:00
|
|
|
| -unity-build | -DQT_UNITY_BUILD=ON | |
|
|
|
|
|
| -unity-build-batch-size <int> | -DQT_UNITY_BUILD_BATCH_SIZE=<int> | |
|
2020-10-01 14:48:37 +02:00
|
|
|
| -warnings-are-errors | -DWARNINGS_ARE_ERRORS=ON | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -no-pkg-config | -DFEATURE_pkg_config=OFF | |
|
2023-07-11 14:58:50 +02:00
|
|
|
| -vcpkg | -DQT_USE_VCPKG=ON | |
|
2020-08-13 14:36:50 +02:00
|
|
|
| -D <string> | -DQT_EXTRA_DEFINES=<string1>;<string2> | |
|
|
|
|
|
| -I <string> | -DQT_EXTRA_INCLUDEPATHS=<string1>;<string2> | |
|
|
|
|
|
| -L <string> | -DQT_EXTRA_LIBDIRS=<string1>;<string2> | |
|
|
|
|
|
| -F <string> | -DQT_EXTRA_FRAMEWORKPATHS=<string1>;<string2> | |
|
2024-03-18 11:58:22 +01:00
|
|
|
| -sdk <sdk> | -DQT_APPLE_SDK=<value> | Should be provided a value like 'iphoneos' or 'iphonesimulator' |
|
2020-10-08 19:32:16 +02:00
|
|
|
| | | If no value is provided, a simulator_and_device build is |
|
|
|
|
|
| | | assumed. |
|
2020-10-05 14:49:39 +02:00
|
|
|
| -android-sdk <path> | -DANDROID_SDK_ROOT=<path> | |
|
2022-02-23 12:25:03 +01:00
|
|
|
| -android-ndk <path> | -DCMAKE_TOOLCHAIN_FILE=<toolchain file in NDK> | |
|
2023-03-14 13:46:28 +02:00
|
|
|
| -android-ndk-platform android-28 | -DANDROID_PLATFORM=android-28 | |
|
2020-10-05 14:49:39 +02:00
|
|
|
| -android-abis <abi_1>,...,<abi_n> | -DANDROID_ABI=<abi_1> | only one ABI can be specified |
|
|
|
|
|
| -android-style-assets | -DFEATURE_android_style_assets=ON | |
|
2020-09-11 20:28:01 +03:00
|
|
|
| -android-javac-source | -DQT_ANDROID_JAVAC_SOURCE=7 | Set the javac build source version. |
|
|
|
|
|
| -android-javac-target | -DQT_ANDROID_JAVAC_TARGET=7 | Set the javac build target version. |
|
2022-02-02 17:04:44 +01:00
|
|
|
| -skip <repo>,...,<repo_n> | -DBUILD_<repo>=OFF | |
|
2024-02-07 14:26:45 +01:00
|
|
|
| -skip-tests <repo>,...,<repo_n> | -DQT_BUILD_TESTS_PROJECT_<repo>=OFF | |
|
|
|
|
|
| -skip-examples <repo>,...,<repo_n> | -DQT_BUILD_EXAMPLES_PROJECT_<repo>=OFF | |
|
2024-04-17 13:20:44 +02:00
|
|
|
| -submodules <repo>,...,<repo_n> | -DQT_BUILD_SUBMODULES=<repo>;...;<repo> | |
|
2020-12-02 11:47:24 +01:00
|
|
|
| -make <part> | -DQT_BUILD_TESTS=ON | A way to turn on tools explicitly is missing. If tests/examples |
|
|
|
|
|
| | -DQT_BUILD_EXAMPLES=ON | are enabled, you can disable their building as part of the |
|
|
|
|
|
| | | 'all' target by also passing -DQT_BUILD_TESTS_BY_DEFAULT=OFF or |
|
|
|
|
|
| | | -DQT_BUILD_EXAMPLES_BY_DEFAULT=OFF. Note that if you entirely |
|
|
|
|
|
| | | disable tests/examples at configure time (by using |
|
|
|
|
|
| | | -DQT_BUILD_TESTS=OFF or -DQT_BUILD_EXAMPLES=OFF) you can't then |
|
2022-02-23 12:25:03 +01:00
|
|
|
| | | build them separately, after configuration. |
|
2020-10-19 13:35:15 +02:00
|
|
|
| -nomake <part> | -DQT_BUILD_TESTS=OFF | A way to turn off tools explicitly is missing. |
|
|
|
|
|
| | -DQT_BUILD_EXAMPLES=OFF | |
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 12:15:35 +02:00
|
|
|
| -install-examples-sources | -DQT_INSTALL_EXAMPLES_SOURCES=ON | |
|
2020-12-08 22:45:21 +08:00
|
|
|
| -no-gui | -DFEATURE_gui=OFF | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -no-widgets | -DFEATURE_widgets=OFF | |
|
|
|
|
|
| -no-dbus | -DFEATURE_dbus=OFF | |
|
|
|
|
|
| -dbus [linked/runtime] | -DINPUT_dbus=[linked/runtime] | |
|
|
|
|
|
| -dbus-linked | -DINPUT_dbus=linked | |
|
|
|
|
|
| -dbus-runtime | -DINPUT_dbus=runtime | |
|
|
|
|
|
| -accessibility | -DFEATURE_accessibility=ON | |
|
|
|
|
|
| -doubleconversion | -DFEATURE_doubleconversion=ON | |
|
|
|
|
|
| | -DFEATURE_system_doubleconversion=ON/OFF | |
|
|
|
|
|
| -glib | -DFEATURE_glib=ON | |
|
|
|
|
|
| -inotify | -DFEATURE_inotify=ON | |
|
|
|
|
|
| -icu | -DFEATURE_icu=ON | |
|
|
|
|
|
| -pcre | -DFEATURE_pcre2=ON | |
|
|
|
|
|
| -pcre [system/qt] | -DFEATURE_system_pcre2=ON/OFF | |
|
|
|
|
|
| -pps | n/a | QNX feature. Not available for 6.0. |
|
|
|
|
|
| -zlib [system/qt] | -DFEATURE_system_zlib=ON/OFF | |
|
|
|
|
|
| -ssl | -DFEATURE_ssl=ON | |
|
|
|
|
|
| -openssl [no/yes/linked/runtime] | -DINPUT_openssl=no/yes/linked/runtime | |
|
|
|
|
|
| -openssl-linked | -DINPUT_openssl=linked | |
|
|
|
|
|
| -openssl-runtime | -DINPUT_openssl=runtime | |
|
|
|
|
|
| -schannel | -DFEATURE_schannel=ON | |
|
|
|
|
|
| -securetransport | -DFEATURE_securetransport=ON | |
|
|
|
|
|
| -sctp | -DFEATURE_sctp=ON | |
|
|
|
|
|
| -libproxy | -DFEATURE_libproxy=ON | |
|
|
|
|
|
| -system-proxies | -DFEATURE_system_proxies=ON | |
|
|
|
|
|
| -cups | -DFEATURE_cups=ON | |
|
|
|
|
|
| -fontconfig | -DFEATURE_fontconfig=ON | |
|
|
|
|
|
| -freetype [no/qt/system] | -DFEATURE_freetype=ON/OFF | |
|
|
|
|
|
| | -DFEATURE_system_freetype=ON/OFF | |
|
|
|
|
|
| -harfbuzz [no/qt/system] | -DFEATURE_harfbuzz=ON | |
|
|
|
|
|
| | -DFEATURE_system_harfbuzz=ON/OFF | |
|
|
|
|
|
| -gtk | -DFEATURE_gtk3=ON | |
|
|
|
|
|
| -lgmon | n/a | QNX-specific |
|
2020-12-08 22:45:21 +08:00
|
|
|
| -no-opengl | -DINPUT_opengl=no | |
|
|
|
|
|
| -opengl <api> | -DINPUT_opengl=<api> | |
|
|
|
|
|
| -opengles3 | -DFEATURE_opengles3=ON | |
|
|
|
|
|
| -egl | -DFEATURE_egl=ON | |
|
2024-04-11 10:55:53 +02:00
|
|
|
| -qpa <name>;...;<name_n> | -DQT_QPA_PLATFORMS=<name>;...;<name_n> | |
|
|
|
|
|
| -default-qpa <name> | -DQT_QPA_DEFAULT_PLATFORM=<name> | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -xcb-xlib | -DFEATURE_xcb_xlib=ON | |
|
|
|
|
|
| -direct2d | -DFEATURE_direct2d=ON | |
|
|
|
|
|
| -directfb | -DFEATURE_directfb=ON | |
|
|
|
|
|
| -eglfs | -DFEATURE_eglfs=ON | |
|
|
|
|
|
| -gbm | -DFEATURE_gbm=ON | |
|
|
|
|
|
| -kms | -DFEATURE_kms=ON | |
|
|
|
|
|
| -linuxfb | -DFEATURE_linuxfb=ON | |
|
|
|
|
|
| -xcb | -DFEATURE_xcb=ON | |
|
|
|
|
|
| -libudev | -DFEATURE_libudev=ON | |
|
|
|
|
|
| -evdev | -DFEATURE_evdev=ON | |
|
|
|
|
|
| -imf | n/a | QNX-specific |
|
|
|
|
|
| -libinput | -DFEATURE_libinput=ON | |
|
|
|
|
|
| -mtdev | -DFEATURE_mtdev=ON | |
|
2020-08-20 15:19:07 +02:00
|
|
|
| -tslib | -DFEATURE_tslib=ON | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -bundled-xcb-xinput | -DFEATURE_system_xcb_xinput=OFF | |
|
|
|
|
|
| -xkbcommon | -DFEATURE_xkbcommon=ON | |
|
|
|
|
|
| -gif | -DFEATURE_gif=ON | |
|
|
|
|
|
| -ico | -DFEATURE_ico=ON | |
|
2024-03-07 12:08:09 +01:00
|
|
|
| -libpng | -DFEATURE_png=ON | |
|
|
|
|
|
| -libjpeg | -DFEATURE_jpeg=ON | |
|
2020-08-21 21:33:07 +02:00
|
|
|
| -sql-<driver> | -DFEATURE_sql_<driver>=ON | |
|
|
|
|
|
| -sqlite [qt/system] | -DFEATURE_system_sqlite=OFF/ON | |
|
2022-08-16 13:02:27 +02:00
|
|
|
| -disable-deprecated-up-to <hex_version> | -DQT_DISABLE_DEPRECATED_UP_TO=<hex_version> | |
|
2022-11-14 12:16:28 +01:00
|
|
|
| -mimetype-database-compression <type> | -DINPUT_mimetype_database_compression=<type> | Sets the compression type for mime type database. Supported |
|
|
|
|
|
| | | types: gzip, zstd, none. |
|
2023-09-22 14:10:09 +02:00
|
|
|
| -force-bundled-libs | -DFEATURE_force_bundled_libs=ON | |
|
|
|
|
|
| -force-system-libs | -DFEATURE_force_system_libs=ON | |
|
2024-11-22 23:35:47 +01:00
|
|
|
| -ffmpeg-dir | -DFFMPEG_DIR=<dir> | FFmpeg development libraries directory |
|
|
|
|
|
| -ffmpeg-deploy | -DQT_DEPLOY_FFMPEG=ON | FFmpeg binaries will be copied to Qt's install directory |
|
