qtp0007.qdoc

Go to the documentation of this file.

// Copyright (C) 2026 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
\page qt-cmake-policy-qtp0007.html
\ingroup qt-cmake-policies
\since 6.12
\title QTP0007
\keyword qt_cmake_policy_qtp0007
 
\summary {Quotes and escapes forwarded argument values in generated deploy scripts.}
 
This policy was introduced in Qt 6.12. The policy affects how
\l{qt_generate_deploy_app_script()} writes the values of the keywords it forwards
to \l{qt_deploy_runtime_dependencies()}, such as \c{DEPLOY_TOOL_OPTIONS},
\c{PRE_EXCLUDE_REGEXES} and \c{POST_EXCLUDE_FILES}, into the deploy script it
generates.
 
If the policy is set to \c OLD, the values are written unquoted. When the
generated script runs, cmake splits each value at whitespace and interprets
backslashes in it as escape sequences. This causes issues with values that
contain whitespace, backslashes or double quotes.
 
If the policy is set to \c NEW, each value is written as a quoted argument, with
backslashes and double quotes escaped, so that the value reaches
\l{qt_deploy_runtime_dependencies()} unchanged.
 
When the policy is not set and a forwarded value contains whitespace, a backslash
or a double quote, an \c{AUTHOR_WARNING} is emitted and the values are written
unquoted for backwards compatibility. Values without those characters are
unaffected, so no warning is emitted for them.
 
For example, a code signing identity that contains spaces:
\badcode
# QTP0007 not set - AUTHOR_WARNING is emitted
qt_generate_deploy_app_script(
    TARGET MyApp
    OUTPUT_SCRIPT deploy_script
    DEPLOY_TOOL_OPTIONS "-codesign=Developer ID Application: Foo"
)
\endcode
 
The identity reaches \c macdeployqt as several arguments, and the code signing
step either picks the wrong identity or fails. Setting the policy to \c NEW
passes it on as a single argument:
\badcode
qt_policy(SET QTP0007 NEW)
qt_generate_deploy_app_script(
    TARGET MyApp
    OUTPUT_SCRIPT deploy_script
    DEPLOY_TOOL_OPTIONS "-codesign=Developer ID Application: Foo"
)
\endcode
 
Note that a project which put several options into one whitespace-separated
value relied on the \c OLD behavior to split them, and has to pass them as
separate list elements once the policy is set to \c NEW:
\badcode
# Relies on the \c OLD behavior to split the value into four options.
set(options "-hardened-runtime -timestamp -appstore-compliant -verbose=3")
\endcode
\badcode
# Correct way to pass options with the \c NEW behavior.
set(options -hardened-runtime -timestamp -appstore-compliant -verbose=3)
\endcode
 
\qtpolicydeprecatedbehavior
 
\sa qt_policy(), {Qt CMake policies}, qt_generate_deploy_app_script(),
    qt_deploy_runtime_dependencies()
 
*/