diff options
author | Alexandru Croitor <alexandru.croitor@qt.io> | 2021-12-09 12:23:27 +0100 |
---|---|---|
committer | Alexandru Croitor <alexandru.croitor@qt.io> | 2021-12-09 19:59:55 +0100 |
commit | 197753d8aea5e550338dabbabf9dd656c611bbcf (patch) | |
tree | 4615096f8d6c64fb46190b21f0d9bb841d578ec8 /src/corelib/doc | |
parent | 0a28c55a879251ca334866f15859adabd7e6118e (diff) |
CMake: Mark the new deployment API as being in Technical Preview
Amends 22c92f39670d0376478cc2e73a17307508f86692
Task-number: QTBUG-98545
Change-Id: Ifaa7e4884f0eb1caa6d3d4906a2701f8fa5e43c2
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Diffstat (limited to 'src/corelib/doc')
6 files changed, 22 insertions, 0 deletions
diff --git a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc index af0452fc6b..dab62cbcba 100644 --- a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc +++ b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc @@ -182,6 +182,8 @@ must be set before the first \c{find_package(Qt6)} call to have that effect. \summary {Name of the file to include for setting up deployment support.} +\preliminarycmakevariable + 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. @@ -204,6 +206,8 @@ an application, along with its runtime dependencies: \summary {Prevents subsequent calls to qt_standard_project_setup() from making any changes.} +\preliminarycmakevariable + 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 diff --git a/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc b/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc index 55d467309b..0c9d66812a 100644 --- a/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc +++ b/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc @@ -43,6 +43,8 @@ \include cmake-deploy-var-usage.qdocinc +\preliminarycmakevariable + \c{QT_DEPLOY_PREFIX} provides the base directory of the deployment. The other \c{QT_DEPLOY_..._DIR} variables should be treated as relative to this location. The value of \c{QT_DEPLOY_PREFIX} may be relative or absolute, so projects @@ -78,6 +80,8 @@ variables. \include cmake-deploy-var-usage.qdocinc +\preliminarycmakevariable + Projects should use \c QT_DEPLOY_BIN_DIR in their deploy scripts instead of hard-coding a particular directory in which to deploy the following types of binaries: @@ -113,6 +117,8 @@ should not be used for that scenario. \include cmake-deploy-var-usage.qdocinc +\preliminarycmakevariable + Projects should use \c QT_DEPLOY_LIB_DIR in their deploy scripts instead of hard-coding a particular directory in which to deploy the following types of binaries: @@ -144,6 +150,8 @@ should not be used for that scenario. \include cmake-deploy-var-usage.qdocinc +\preliminarycmakevariable + Projects should use \c QT_DEPLOY_PLUGINS_DIR in their deploy scripts instead of hard-coding a particular directory under which to deploy plugins. @@ -170,6 +178,8 @@ bundle contents. \include cmake-deploy-var-usage.qdocinc +\preliminarycmakevariable + Projects should use \c QT_DEPLOY_QML_DIR in their deploy scripts instead of hard-coding a particular directory under which to deploy QML modules. diff --git a/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc b/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc index 173c9230f8..abd1991b13 100644 --- a/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc +++ b/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc @@ -40,6 +40,8 @@ Unlike most other CMake commands provided by Qt, \c{qt_deploy_qt_conf()} can only be called from a deployment script. It cannot be called directly by the project. +\preliminarycmakecommand + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_deploy_runtime_dependencies.qdoc b/src/corelib/doc/src/cmake/qt_deploy_runtime_dependencies.qdoc index 1cfee0331e..0a41de7b02 100644 --- a/src/corelib/doc/src/cmake/qt_deploy_runtime_dependencies.qdoc +++ b/src/corelib/doc/src/cmake/qt_deploy_runtime_dependencies.qdoc @@ -40,6 +40,8 @@ Unlike most other CMake commands provided by Qt, \c{qt_deploy_runtime_dependenci can only be called from a deployment script. It cannot be called directly by the project during the configure stage. +\preliminarycmakecommand + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc b/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc index 0869f7ed0a..103fad3761 100644 --- a/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc +++ b/src/corelib/doc/src/cmake/qt_generate_deploy_app_script.qdoc @@ -36,6 +36,8 @@ \include cmake-find-package-core.qdocinc +\preliminarycmakecommand + \section1 Synopsis \badcode diff --git a/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc b/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc index 6c3fcc3f93..da53bb4cef 100644 --- a/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc +++ b/src/corelib/doc/src/cmake/qt_standard_project_setup.qdoc @@ -36,6 +36,8 @@ \include cmake-find-package-core.qdocinc +\preliminarycmakecommand + \section1 Synopsis \badcode |