diff options
Diffstat (limited to 'config_help.txt')
| -rw-r--r-- | config_help.txt | 117 |
1 files changed, 85 insertions, 32 deletions
diff --git a/config_help.txt b/config_help.txt index 6ca76433f9..13fc516da5 100644 --- a/config_help.txt +++ b/config_help.txt @@ -7,10 +7,12 @@ Top-level installation directories: -prefix <dir> ...... The deployment directory, as seen on the target device. [/usr/local/Qt-$QT_VERSION; qtbase build directory if -developer-build] + -no-prefix ......... The deployment directory is set to the qtbase build + directory. Can be used instead of -developer-build + to not have to install, as well as avoid + -developer-build's default of -warnings-are-errors. -extprefix <dir> ... The installation directory, as seen on the host machine. [SYSROOT/PREFIX] - -external-hostbindir <path> ... Path to Qt tools built for this machine. - This option is required when cross-compiling Qt. Fine tuning of installation directory layout. Note that all directories except -sysconfdir should be located under -prefix: @@ -42,7 +44,9 @@ options without auto-detection. Configure meta: -help, -h ............ Display this help screen - -redo ................ Re-configure with previously used options. + -redo ................ Re-configure with previously used options. In addition, + redo removes CMakeCache.txt file and CMakeFiles/ directory + and recreates them from scratch. Additional options may be passed, but will not be saved for later use by -redo. @@ -57,11 +61,16 @@ Build options: CMake instead of auto-detecting one. -cmake-use-default-generator ... Turn off auto-detection of the CMake build system generator. + -cmake-file-api ...... Let CMake store build metadata for loading the build + into an IDE. [no; yes if -developer-build] -no-guess-compiler ... Do not guess the compiler from the target mkspec. - -release ............. Build Qt with debugging turned off [yes] - -debug ............... Build Qt with debugging turned on [no] - -debug-and-release ... Build two versions of Qt, with and without - debugging turned on [yes] (Apple and Windows only) + -release ............. Build Qt with optimizations and without debug + symbols [yes] + Note that -developer-build implies -debug unless + -release is also explicitly specified + -debug ............... Build Qt without optimizations and with debug symbols + [no] + -debug-and-release ... Build two versions of Qt in one build tree [no] -optimize-debug ...... Enable debug-friendly optimizations in debug builds [auto] (Not supported with MSVC or Clang toolchains) -optimize-size ....... Optimize release builds for size instead of speed [no] @@ -74,7 +83,8 @@ Build options: sections. [auto for static builds, otherwise no] -force-asserts ....... Enable Q_ASSERT even in release builds [no] -developer-build ..... Compile and link Qt for developing Qt itself - (exports for auto-tests, extra checks, etc.) [no] + (exports for auto-tests, extra checks, implies + -no-prefix, etc.) [no] -shared .............. Build shared Qt libraries [yes] (no for UIKit) -static .............. Build static Qt libraries [no] (yes for UIKit) @@ -89,15 +99,18 @@ Build options: through an app store by default, in particular Android, iOS, tvOS, and watchOS. [auto] + -qt-host-path <path> . Specify path to a Qt host build for cross-compiling. -qtnamespace <name> .. Wrap all Qt library code in 'namespace <name> {...}'. + -qtinlinenamespace ... Make -qtnamespace an inline namespace -qtlibinfix <infix> .. Rename all libQt6*.so to libQt6*<infix>.so. - -testcocoon .......... Instrument with the TestCocoon code coverage tool [no] + -coverage <tool> ..... Instrument with the code coverage tool. -gcov ................ Instrument with the GCov code coverage tool [no] -trace [backend] ..... Enable instrumentation with tracepoints. - Currently supported backends are 'etw' (Windows) and - 'lttng' (Linux), or 'yes' for auto-detection. [no] + Currently supported backends are 'etw' (Windows), + 'lttng' (Linux), 'ctf' (Common Trace Format, cross-platform) + or 'yes' for auto-detection. [no] -sanitize {address|thread|memory|fuzzer-no-link|undefined} Instrument with the specified compiler sanitizer. @@ -105,17 +118,6 @@ Build options: for example, -sanitize address cannot be combined with -sanitize thread. - -coverage {trace-pc-guard|source-based} - Specify the 'trace-pc-guard' coverage instrumentation for - sanitizers or generate instrumented code to collect execution - counts and enable code coverage analysis, respectively. (Clang only) - - -c++std <edition> .... Select C++ standard <edition> [c++2a/c++17/c++14/c++11] - - -sse2 ................ Use SSE2 instructions [auto] - -sse3/-ssse3/-sse4.1/-sse4.2/-avx/-avx2/-avx512 - Enable use of particular x86 instructions [auto] - Enabled ones are still subject to runtime detection. -mips_dsp/-mips_dspr2 Use MIPS DSP/rev2 instructions [auto] -qreal <type> ........ typedef qreal to the specified type. [double] @@ -137,18 +139,43 @@ Build options: -pch ................. Use precompiled headers [auto] -ltcg ................ Use Link Time Code Generation [no] - -linker [bfd,gold,lld] Force use of the GNU ld, GNU gold or LLVM/LLD linker - instead of default one (GCC only) + -intelcet ............ Use Intel Control-flow Enforcement Technology [auto] + -glibc-fortify-source Use Glibc function fortification [auto] + -trivial-auto-var-init-pattern + Use -ftrivial-auto-var-init=pattern [auto] + -stack-protector ..... Use -fstack-protector-strong [auto] + -stack-clash-protection + Use -fstack-clash-protection [auto] + -libstdcpp-assertions Use libstdc++ assertions [auto] + -libcpp-hardening .... Use libc++ hardening [auto] + -relro-now-linker .... Use -z relro -z now when linking [auto] + -linker [bfd,gold,lld,mold] + Force use of the GNU ld, GNU gold, LLVM/LLD or mold + linker instead of default one (GCC and clang only) -ccache .............. Use the ccache compiler cache [no] (Unix only) + -unity-build ......... Enable Unity (Jumbo) build + -unity-build-batch-size <int> + Maximum number of source files used by the unity build + to create unity source files [32] -warnings-are-errors . Treat warnings as errors [no; yes if -developer-build] -Build environment: + -disable-deprecated-up-to <version> + Set the QT_DISABLE_DEPRECATED_UP_TO value to <version>. + QT_DISABLE_DEPRECATED_UP_TO is used to remove + deprecated methods from both API and ABI. + <version> is a hex value, for example 0x060500 can be + used to remove all code deprecated in Qt 6.5.0 or + earlier releases. + By default <version> is set to 0x040000 and 0x050000 on + Windows, and non-Windows respectively. - -sysroot <dir> ....... Set <dir> as the target sysroot +Build environment: -pkg-config .......... Use pkg-config [auto] (Unix only) + -vcpkg ............... Use vcpkg [no] + -D <string> .......... Pass additional preprocessor define -I <string> .......... Pass additional include path -L <string> .......... Pass additional library path @@ -171,12 +198,39 @@ Build environment: Component selection: - -skip <repo> ......... Exclude an entire repository from the build. + -submodules <repo>[,<repo>] ... Build the listed repositories and those they + depend on rather than all checked-out repositories. + The list should be separated with commas, e.g. + -submodules qtsvg,qtnetworkauth + [default is to build all checked out repositories] + -skip <repo>[,<repo>] Exclude one or more entire repositories from the + build. The list should be separated with commas. + e.g. -skip qtimageformats,qtsvg + -skip-tests <repo>[,<repo>] ... Skip building tests for one or more + repositories. The list should be separated with commas. + e.g. -skip-tests qtimageformats,qtsvg + -skip-examples <repo>[,<repo>] ... Skip building examples for one or more + repositories. The list should be separated with commas. + e.g. -skip-examples qtimageformats,qtsvg + -init-submodules ..... When configure is called from the qt git super module, + it will automatically clone and initialize the + repositories specified by the -submodules option. When + no -submodules are specified, and no existing + submodules are cloned, a default set of submodules + will be initialized. To adjust other aspects of the + cloning process, check the init-repository --help + output for additional options that can be passed + to configure. -make <part> ......... Add <part> to the list of parts to be built. Specifying this option clears the default list first. - [libs and examples, also tools if not cross-building, - also tests if -developer-build] + (allowed values: libs, tools, examples, tests, + benchmarks, manual-tests, minimal-static-tests) + [default: libs and examples, also tools if not + cross-building, also tests if -developer-build] -nomake <part> ....... Exclude <part> from the list of parts to be built. + -install-examples-sources Installs examples source code into the Qt prefix + Only possible when -make examples is also passed + [no] -gui ................. Build the Qt GUI module and dependencies [yes] -widgets ............. Build the Qt Widgets module and dependencies [yes] -no-dbus ............. Do not build the Qt D-Bus module @@ -194,7 +248,6 @@ Core options: -doubleconversion .... Select used double conversion library [system/qt/no] No implies use of sscanf_l and snprintf_l (imprecise). -glib ................ Enable Glib support [no; auto on Unix] - -eventfd ............. Enable eventfd support -inotify ............. Enable inotify support -icu ................. Enable ICU support [auto] -pcre ................ Select used libpcre2 [system/qt/no] @@ -211,7 +264,7 @@ Network options: -no-openssl .......... Do not use OpenSSL [default on Apple] -openssl-linked ...... Use OpenSSL and link to libssl [no] -openssl-runtime ..... Use OpenSSL and dynamically load libssl [auto] - -schannel ............ Use Secure Channel [no] (Windows only) + -schannel ............ Use Secure Channel [auto] (Windows only) -securetransport ..... Use SecureTransport [auto] (Apple only) -sctp ................ Enable SCTP support [no] @@ -268,6 +321,6 @@ Gui, printing, widget options: Database options: -sql-<driver> ........ Enable SQL <driver> plugin. Supported drivers: - db2 ibase mysql oci odbc psql sqlite + db2 ibase mysql oci odbc psql sqlite mimer [all auto] -sqlite .............. Select used sqlite [system/qt] |