Doc: Address qt_generate_deploy_app_script issues from API review

Task-number: QTBUG-121708
Change-Id: Id0beb7c3045513e1665bd4062f7236243898b7c1
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
(cherry picked from commit 5d1ddee4cc38f684ed635a2b917c61db80a27ff6)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Joerg Bornemann 2024-01-31 09:41:51 +01:00 committed by Qt Cherry-pick Bot
parent cbfc5a0a95
commit 01a0b81998
2 changed files with 27 additions and 2 deletions

View File

@ -75,8 +75,9 @@ customized way.
For Windows desktop applications, the required runtime files for the compiler For Windows desktop applications, the required runtime files for the compiler
are also installed by default. To prevent this, specify \c{NO_COMPILER_RUNTIME}. are also installed by default. To prevent this, specify \c{NO_COMPILER_RUNTIME}.
You can use \c{DEPLOY_TOOL_OPTIONS} to pass additional options to the underlying Since Qt 6.7, you can use \c{DEPLOY_TOOL_OPTIONS} to pass additional options to
deployment tool. the underlying deployment tool. This only has an effect if the underlying
deployment tool is either macdeployqt or windeployqt.
For deploying a QML application, use For deploying a QML application, use
\l{qt6_generate_deploy_qml_app_script}{qt_generate_deploy_qml_app_script()} \l{qt6_generate_deploy_qml_app_script}{qt_generate_deploy_qml_app_script()}
@ -97,5 +98,13 @@ unmodified to \l{qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies
\section1 Example \section1 Example
The following example shows how to deploy an application \c{MyApp}.
\include cmake-generate-deploy-app-script.qdocinc \include cmake-generate-deploy-app-script.qdocinc
The following example shows how to use the \c{DEPLOY_TOOL_OPTIONS} parameter to
pass different options to macdeployqt and windeployqt.
\include cmake-generate-deploy-app-script-deploy-tool-options.qdocinc
*/ */

View File

@ -0,0 +1,16 @@
\badcode
set(deploy_tool_options_arg "")
if(APPLE)
set(deploy_tool_options_arg --hardened-runtime)
elseif(WIN32)
set(deploy_tool_options_arg --no-compiler-runtime)
endif()
qt_generate_deploy_app_script(
TARGET MyApp
OUTPUT_SCRIPT deploy_script
NO_UNSUPPORTED_PLATFORM_ERROR
DEPLOY_TOOL_OPTIONS ${deploy_tool_options_arg}
)
install(SCRIPT ${deploy_script})
\endcode