qt_generate_deploy_script.qdoc

Go to the documentation of this file.

// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
\page qt-generate-deploy-script.html
\ingroup cmake-commands-qtcore
 
\title qt_generate_deploy_script
\keyword qt_generate_deploy_script()
 
\summary {Generate a custom deployment script.}
 
\include cmake-find-package-core.qdocinc
 
\cmakecommandsince 6.5
 
\section1 Synopsis
 
\badcode
qt_generate_deploy_script(
    OUTPUT_SCRIPT <var>
    [TARGET target]
    [NAME script_name]
    [CONTENT content]
)
\endcode
 
\versionlessCMakeCommandsNote qt6_generate_deploy_script()
 
\section1 Description
 
The command generates a script whose full file path will be stored in the
variable named by the \c{OUTPUT_SCRIPT} option. That script is only written
at CMake generation time. It is intended to be used with the \l{install(SCRIPT)}
command, which should come after the application's target has been installed
using \l{install(TARGETS)}.
 
The command takes care of generating a file named suitably for multi-config
generators. Necessary includes are added such that Qt's CMake deployment
functions and variables are accessible.
 
The \c TARGET argument specifies the target that will be deployed by the script.
This affects the file name of the generated script, unless \c NAME is specified.
 
The \c NAME argument controls an identifiable portion within the deployment
script's automatically generated name. The \c NAME argument defaults to \c
custom if neither \c NAME nor \c TARGET are given.
 
The \c CONTENT argument specifies the code that is written to the deployment
script. The content may contain generator expressions.
 
\note When using the version-less \l qt_generate_deploy_script command,
escape sequences and \c{${var}} references in the content only reach the
generated script unchanged if \l {QTP0008} is set to \c NEW. With the \c OLD
behavior they are evaluated at the call site while the arguments are forwarded,
so a \c{QT_DEPLOY_*} reference that is meant to be expanded when the script runs,
instead gets expanded at configure time, leading to an empty value.
Calling \c qt6_generate_deploy_script() directly avoids this issue.
 
This command is intended for generating custom deployment scripts that
directly call functions of Qt's deployment API. For less complex
deployment purposes, it is more convenient to use
\l qt_generate_deploy_app_script() or
\l qt_generate_deploy_qml_app_script().
 
\sa qt_generate_deploy_app_script(),
    qt_generate_deploy_qml_app_script(),
    {QTP0008}
 
\section1 Example
 
\snippet cmake-macros/deployment.cmake qt_generate_deploy_script_example
 
*/