CMake: Mark the new deployment API as being in Technical Preview

Amends 22c92f3967

Task-number: QTBUG-98545
Change-Id: Ifaa7e4884f0eb1caa6d3d4906a2701f8fa5e43c2
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
bb10
Alexandru Croitor 2021-12-09 12:23:27 +01:00
parent 0a28c55a87
commit 197753d8ae
8 changed files with 30 additions and 0 deletions

View File

@ -4,6 +4,8 @@
cmake_minimum_required(VERSION 3.16...3.21)
# This function is currently in Technical Preview.
# Its signature and behavior might change.
function(qt_deploy_qt_conf file_to_write)
set(no_value_options "")
set(single_value_options
@ -85,6 +87,8 @@ function(qt_deploy_qt_conf file_to_write)
file(WRITE "${file_to_write}" "${contents}")
endfunction()
# This function is currently in Technical Preview.
# Its signature and behavior might change.
function(qt_deploy_runtime_dependencies)
if(NOT __QT_DEPLOY_TOOL)

View File

@ -2577,6 +2577,8 @@ endfunction()
# Note this needs to be a macro because it sets variables intended for the
# calling scope.
# This function is currently in Technical Preview.
# Its signature and behavior might change.
macro(qt6_standard_project_setup)
# A parent project might want to prevent child projects pulled in with
# add_subdirectory() from changing the parent's preferred arrangement.
@ -2633,6 +2635,8 @@ if(NOT QT_NO_CREATE_VERSIONLESS_FUNCTIONS)
endmacro()
endif()
# This function is currently in Technical Preview.
# Its signature and behavior might change.
function(qt6_generate_deploy_app_script)
# We use a TARGET keyword option instead of taking the target as the first
# positional argument. This is to keep open the possibility of deploying

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc
\preliminarycmakecommand
\section1 Synopsis
\badcode

View File

@ -36,6 +36,8 @@
\include cmake-find-package-core.qdocinc
\preliminarycmakecommand
\section1 Synopsis
\badcode