diff options
| author | Alexandru Croitor <alexandru.croitor@qt.io> | 2022-02-28 11:27:33 +0100 |
|---|---|---|
| committer | Alexandru Croitor <alexandru.croitor@qt.io> | 2022-02-28 23:08:21 +0100 |
| commit | 8b5648743efa84ed49bcec0c11d30efa8b15718c (patch) | |
| tree | 72f5d735ebfdc989168cdee84a54019452fa104a /src/corelib/doc/src/cmake/cmake-configure-variables.qdoc | |
| parent | d0d1d7403377363a101d4f1781d06a9b44787d0a (diff) | |
CMake: Clean up docs of deployment variables for 6.3
Clarified the docs that using the deployment variables is for avoiding
hard-coding of specific paths.
Added docs on how to customize the variable defaults
Added example doc snippet demonstrating how to modify the values.
Added upstream doc links where relevant.
Pick-to: 6.3
Fixes: QTBUG-100924
Change-Id: I938dcadd776c8b7019da4709dfced166454a6c92
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/corelib/doc/src/cmake/cmake-configure-variables.qdoc')
| -rw-r--r-- | src/corelib/doc/src/cmake/cmake-configure-variables.qdoc | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc index aec582aa00..ba8bc6e9c0 100644 --- a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc +++ b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc @@ -262,10 +262,13 @@ must be set before the first \c{find_package(Qt6)} call to have that effect. \cmakevariablesince 6.3 \preliminarycmakevariable +\note The value of this variable should never be modified by project code. -This variable is set by the Core package. It is intended to be used as the first -line of any deployment script. Such scripts do not run during CMake's configure -phase, they are executed during installation or as part of a post-build rule. +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 +part of a post-build rule. The following example shows one way the variable would be used when installing an application, along with its runtime dependencies: |