Skip to content

Commit

Permalink
Doc: Edit CMake Qt6 Core variable docs
Browse files Browse the repository at this point in the history 
Edit the docs for style and consistency.

Pick-to: 6.6.0 6.6 6.5
Change-Id: I24fb7f8b833ae7e5adaca31811bd171d892c5907
Reviewed-by: Joerg Bornemann <[email protected]>
  • Loading branch information
@leena-miettinen
leena-miettinen committed Sep 22, 2023
1 parent 868b721 commit 201c309
Showing 1 changed file with 33 additions and 33 deletions.
66 changes: 33 additions & 33 deletions src/corelib/doc/src/cmake/cmake-configure-variables.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ find_package(Qt6 REQUIRED COMPONENTS Core)
\preliminarycmakevariable
\cmakevariableandroidonly

This is normally set by the Android NDK toolchain file. It is written out as
Usually, this variable is set by the Android NDK toolchain file. It is written out as
part of the deployment settings for a target.

\sa{qt6_android_generate_deployment_settings}{qt_android_generate_deployment_settings()}
Expand All @@ -54,8 +54,8 @@ part of the deployment settings for a target.
\preliminarycmakevariable
\cmakevariableandroidonly

This specifies the location of the Android SDK when building for the Android platform.
It is written out as part of the deployment settings for a target.
Specifies the location of the Android SDK when building for the Android platform.
This variable is written out as part of the deployment settings for a target.

\sa{qt6_android_generate_deployment_settings}{qt_android_generate_deployment_settings()}.
*/
Expand All @@ -73,8 +73,8 @@ It is written out as part of the deployment settings for a target.
\preliminarycmakevariable
\cmakevariableandroidonly

This contains a list of arguments to be passed to Android applications. It is written
out as part of the deployment settings for a target.
Contains a list of arguments to be passed to Android applications. This variable
is written out as part of the deployment settings for a target.

\sa{qt6_android_generate_deployment_settings}{qt_android_generate_deployment_settings()}
*/
Expand All @@ -86,14 +86,14 @@ out as part of the deployment settings for a target.
\title QT_ANDROID_DEPLOY_RELEASE
\target cmake-variable-QT_ANDROID_DEPLOY_RELEASE

\summary {Set the package type as a release}
\summary {Sets the package type as a release.}

\cmakevariablesince 6.5.2
\preliminarycmakevariable
\cmakevariableandroidonly

Setting \c{QT_ANDROID_DEPLOY_RELEASE} to true allows to create release package by passing --release
flag to androiddeployqt tool.
When set to \c TRUE, allows you to create a release package
by passing the \c --release flag to the \c androiddeployqt tool.

\sa {androiddeployqt}
*/
Expand All @@ -105,13 +105,13 @@ flag to androiddeployqt tool.
\title QT_ANDROID_MULTI_ABI_FORWARD_VARS
\target cmake-variable-QT_ANDROID_MULTI_ABI_FORWARD_VARS

\summary {Allows to share CMake variables in multi-ABI builds}
\summary {Allows to share CMake variables in multi-ABI builds.}

\cmakevariablesince 6.4.2
\preliminarycmakevariable
\cmakevariableandroidonly

The \c{QT_ANDROID_MULTI_ABI_FORWARD_VARS} variable allows specifying the list of
Allows specifying the list of
CMake variables that need to be forwarded from the main ABI project to
ABI-specific subprojects. Due to the specifics of the Multi-ABI project build
process, there is no generic way to forward the CMake cache variables
Expand Down Expand Up @@ -168,8 +168,8 @@ endif()
...
\endcode

Setting the variable in this way allows you to have a predefined set of
variables that will always be forwarded to abi-specific projects.
Set the variable in this way to have a predefined set of
variables that will always be forwarded to ABI-specific projects.

\note The forwarding is done in the target finalizer, which is implicitly
called when \l{qt6_add_executable}{qt_add_executable()} is used. The
Expand All @@ -192,7 +192,7 @@ finalization occurs automatically when using CMake 3.19 or later.
\preliminarycmakevariable
\cmakevariableandroidonly

The option automatically detects available ABIs of Qt for Android and uses them to
Automatically detects available ABIs of Qt for Android and uses them to
build a package. The automatic detection expects the default directory structure
supplied by the Qt installer, with the corresponding naming of the directories.
\include cmake-android-supported-abis.qdocinc
Expand All @@ -207,7 +207,7 @@ The typical directory structure looks as below:
\endcode
The auto-detected paths can be customized using one of \c{QT_PATH_ANDROID_ABI_<ABI>} variables.

The variable is set to FALSE by default.
The variable is set to \c FALSE by default.

\sa{QT_PATH_ANDROID_ABI_<ABI>}
*/
Expand All @@ -225,10 +225,10 @@ The variable is set to FALSE by default.
\preliminarycmakevariable
\cmakevariableandroidonly

This variable specifies a list of ABIs to be used to build the project packages.
Specifies a list of ABIs to be used to build the project packages.
\include cmake-android-supported-abis.qdocinc
Each ABI should have the corresponding Qt for Android either installed or
user-built. It's possible to specify the path to the Qt for Android ABI using
user-built. To specify the path to the Qt for Android ABI, use
the corresponding \c{QT_PATH_ANDROID_ABI_<ABI>} variable.

\note \c{QT_ANDROID_BUILD_ALL_ABIS} has the higher priority and ignores the
Expand Down Expand Up @@ -263,20 +263,20 @@ Each variable can be used to specify the path to Qt for Android for the correspo
\title QT_ANDROID_SIGN_AAB
\target cmake-variable-QT_ANDROID_SIGN_AAB

\summary {Sign the .aab package with the specified keystore, alias and store password.}
\summary {Signs the .aab package with the specified keystore, alias, and store password.}
\cmakevariablesince 6.4
\preliminarycmakevariable
\cmakevariableandroidonly

Sign the resulting package. The path of the keystore file, the alias of the key and passwords
Signs the resulting package. The path of the keystore file, the alias of the key, and passwords
have to be specified by additional environment variables:
\badcode
QT_ANDROID_KEYSTORE_PATH
QT_ANDROID_KEYSTORE_ALIAS
QT_ANDROID_KEYSTORE_STORE_PASS
QT_ANDROID_KEYSTORE_KEY_PASS
\endcode
Mentioned variables are used internally by \l{androiddeployqt}.
The mentioned variables are used internally by \l{androiddeployqt}.

\sa{androiddeployqt}
*/
Expand All @@ -288,20 +288,20 @@ Mentioned variables are used internally by \l{androiddeployqt}.
\title QT_ANDROID_SIGN_APK
\target cmake-variable-QT_ANDROID_SIGN_APK

\summary {Sign the package with the specified keystore, alias and store password.}
\summary {Signs the package with the specified keystore, alias, and store password.}
\cmakevariablesince 6.4
\preliminarycmakevariable
\cmakevariableandroidonly

Sign the resulting package. The path of the keystore file, the alias of the key and passwords
Signs the resulting package. The path of the keystore file, the alias of the key, and passwords
have to be specified by additional environment variables:
\badcode
QT_ANDROID_KEYSTORE_PATH
QT_ANDROID_KEYSTORE_ALIAS
QT_ANDROID_KEYSTORE_STORE_PASS
QT_ANDROID_KEYSTORE_KEY_PASS
\endcode
Mentioned variables are used internally by \l{androiddeployqt}.
The mentioned variables are used internally by \l{androiddeployqt}.

\sa{androiddeployqt}
*/
Expand All @@ -323,7 +323,7 @@ During project finalization, the build system collects the locations of
all built shared library targets in the project.
These locations are passed to \l androiddeployqt for deployment consideration when
resolving dependencies between libraries.
Set \c QT_NO_COLLECT_BUILD_TREE_APK_DEPS to \c TRUE to disable this behavior.
To disable this behavior, set this variable to \c TRUE.

\sa {qt6_finalize_project}{qt_finalize_project()}
\sa {cmake-variable-QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS}{QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS}
Expand All @@ -349,7 +349,7 @@ of the currently processed executable target. That includes the target's source
scope and its parents.
The collected locations are passed to \l androiddeployqt for deployment consideration when
resolving dependencies between libraries.
Set \c QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS to \c TRUE to disable this behavior.
To disable this behavior, set this variable to \c TRUE.

\sa {qt6_finalize_project}{qt_finalize_project()}
\sa {cmake-variable-QT_NO_COLLECT_BUILD_TREE_APK_DEPS}{QT_NO_COLLECT_BUILD_TREE_APK_DEPS}
Expand All @@ -366,7 +366,7 @@ Set \c QT_NO_COLLECT_IMPORTED_TARGET_APK_DEPS to \c TRUE to disable this behavio

\cmakevariablesince 6.0

When cross-compiling, this must be set to the install location of Qt for the host
When cross-compiling, this variable must be set to the install location of Qt for the host
platform. It is used to locate tools to be run on the host (\l{moc}, \l{rcc},
\l{androiddeployqt}, and so on).
*/
Expand All @@ -385,7 +385,7 @@ platform. It is used to locate tools to be run on the host (\l{moc}, \l{rcc},
When finalizing an executable target on iOS,
\l{qt6_finalize_target}{qt_finalize_target()} will populate the target's
\c XCODE_ATTRIBUTE_DEVELOPMENT_TEAM property if it hasn't been set.
Set \c QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID to true if you want to prevent this.
To prevent this, set \c QT_NO_SET_XCODE_DEVELOPMENT_TEAM_ID to \c TRUE.
*/

/*!
Expand All @@ -403,7 +403,7 @@ When finalizing an executable target on iOS,
\l{qt6_finalize_target}{qt_finalize_target()} will populate the target's
\c XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER and
\c MACOSX_BUNDLE_GUI_IDENTIFIER properties if they haven't been set.
Set \c QT_NO_SET_XCODE_BUNDLE_IDENTIFIER to true if you want to prevent this.
To prevent this, set \c QT_NO_SET_XCODE_BUNDLE_IDENTIFIER to \c TRUE.
*/

/*!
Expand All @@ -413,7 +413,7 @@ Set \c QT_NO_SET_XCODE_BUNDLE_IDENTIFIER to true if you want to prevent this.
\title QT_ENABLE_VERBOSE_DEPLOYMENT
\target cmake-variable-QT_ENABLE_VERBOSE_DEPLOYMENT

\summary {Enables verbose mode of deployment tools}
\summary {Enables verbose mode of deployment tools.}

\cmakevariablesince 6.3
\preliminarycmakevariable
Expand Down Expand Up @@ -442,7 +442,7 @@ must be set before the first \c{find_package(Qt6)} call to have that effect.
This configure-phase variable is set by the Core package. It is intended to be
used as the first line of any deployment script to ensure access to the
deployment APIs provided by Qt. Such deployment scripts do not run during
CMake's configure phase, they are executed during installation or as
CMake's configure phase. They are executed during installation or as
part of a post-build rule.

The following example shows one way the variable would be used when installing
Expand All @@ -467,11 +467,11 @@ an application, along with its runtime dependencies:

The \l{qt6_standard_project_setup}{qt_standard_project_setup()} command is
typically called in the top level \c{CMakeLists.txt} file of a project. In some
scenarios, such projects may be absorbed as a child project of a larger project
scenarios, such a project may be absorbed as a child project of a larger project
hierarchy. A parent project may want to prevent any child project from applying
changes to the setup. The parent project can achieve this by setting
\c{QT_NO_STANDARD_PROJECT_SETUP} to true before bringing in the child project
via \l{add_subdirectory()}, \l{FetchContent_MakeAvailable()} or other similar
\c{QT_NO_STANDARD_PROJECT_SETUP} to \c TRUE before bringing in the child project
via \l{add_subdirectory()}, \l{FetchContent_MakeAvailable()}, or other similar
methods provided by CMake.

\sa {qt6_standard_project_setup}{qt_standard_project_setup()}
Expand Down Expand Up @@ -537,7 +537,7 @@ This variable can be conveniently set with the
\title QT_IOS_LAUNCH_SCREEN
\target cmake-variable-QT_IOS_LAUNCH_SCREEN

\summary {Path to iOS launch screen storyboard used by all targets}
\summary {Path to iOS launch screen storyboard used by all targets.}

\cmakevariablesince 6.4
\preliminarycmakevariable
Expand Down

0 comments on commit 201c309

Please sign in to comment.