Skip to content

Commit f9c93ba

Browse files
committed
Improve build variables documentation
1 parent e5989dd commit f9c93ba

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

doc/buildvariables.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@ None of these are enabled or set by default, unless stated otherwise.
3434
* `LIB_SUFFIX_64=suffix`: suffix for library install directory
3535
* used when building for 64-bit platforms
3636
* overrides general `LIB_SUFFIX` when building for 64-bit platforms
37-
* `QT_PACKAGE_PREFIX=Qt5`: sets the prefix for Qt packages, by default `Qt5`
38-
* `KF_PACKAGE_PREFIX=KF5`: sets the prefix for KDE Frameworks packages, by
39-
default `KF5``
4037
* `SHELL_COMPLETION_ENABLED=ON/OFF`: enables shell completion in general
4138
(enabled by default)
4239
* `BASH_COMPLETION_ENABLED=ON/OFF`: enables Bash completion (enabled by
@@ -74,7 +71,7 @@ None of these are enabled or set by default, unless stated otherwise.
7471
* coverage report is stored in build directory
7572
* `ENABLE_INSTALL_TARGETS=ON/OFF`: enables creation of install targets (enabled
7673
by default)
77-
* `ENABLE_ESCAPE_CODES_BY_DEAULT`: enables use of escape codes for formatted
74+
* `ENABLE_ESCAPE_CODES_BY_DEAULT=ON/OFF`: enables use of escape codes for formatted
7875
output by default
7976
* enabled by default
8077
* see ApplicationUtilities::NoColorArgument and EscapeCodes::enabled
@@ -148,7 +145,14 @@ the relevant CMake cache variable on the CMake invocation.
148145
available and optional
149146
* `QUICK_GUI=ON/OFF`: enables Qt Quick GUI for projects where it is available
150147
and optional
151-
* `BUILTIN_TRANSLATIONS=ON/OFF`: enables built-in translations in applications
148+
* `QT_PACKAGE_PREFIX=Qt5`: sets the prefix for Qt packages, by default `Qt5`
149+
* use `QT_PACKAGE_PREFIX=Qt6` to build against Qt 6
150+
* `KF_PACKAGE_PREFIX=KF5`: sets the prefix for KDE Frameworks packages, by
151+
default `KF5`
152+
* `ENABLE_QT_TRANSLATIONS=ON/OFF`: enables translations for Qt applications,
153+
enabled by default
154+
* `BUILTIN_TRANSLATIONS=ON/OFF`: enables built-in translations instead of
155+
installing translations as separate files
152156
* `BUILTIN_ICON_THEMES=breeze;breeze-dark;...`: specifies icon themes to
153157
built-in
154158
* `BUILTIN_ICON_THEMES_IN_LIBRARIES=breeze;breeze-dark;...`: same as above but
@@ -278,13 +282,16 @@ controlled by the variables documented above. Most important modules are:
278282
`ApplicationUtilities::ArgumentParser` class of course
279283
* `TestTarget`: adds the test target `check`
280284
* `check` target is *not* required by target `all`
281-
* test target uses files specified in `TEST_HEADER_FILES`/`TEST_SRC_FILES`
285+
* test target is comprised of files specified in `TEST_HEADER_FILES`/`TEST_SRC_FILES`
282286
variables
283287
* test target will automatically link against `cppunit` which is the test
284-
framework used by all my projects; set `META_NO_CPP_UNIT=OFF` in the project
288+
framework used by most my projects; set `META_NO_CPP_UNIT=OFF` in the project
285289
file to prevent this
290+
* `TestUtilities`: provides the `configure_test_target` macro for creating test
291+
targets manually
292+
* see `CMakeLists.txt` of `qtutilities` for an example
286293
* `AndroidApk`: adds a target to create an APK package for Android using
287-
androiddeployqt
294+
androiddeployqt, ignored on other platforms
288295
* `Doxygen`: adds a target to generate documentation using Doxygen
289296
* `WindowsResources`: handles creation of Windows resources to set application
290297
meta data and icon, ignored on other platforms

0 commit comments

Comments
 (0)