diff options
Diffstat (limited to 'src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc')
-rw-r--r-- | src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc b/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc new file mode 100644 index 0000000000..5a7bbdc33f --- /dev/null +++ b/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc @@ -0,0 +1,82 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! +\page qt-android-generate-deployment-settings.html +\ingroup cmake-commands-qtcore + +\title qt_android_generate_deployment_settings +\keyword qt6_android_generate_deployment_settings + +\summary {Generates the deployment settings file needed by androiddeployqt.} + +\include cmake-find-package-core.qdocinc + +\cmakecommandsince 6.0 +\warning This command is deprecated since Qt 6.5. Use \l qt_add_executable instead. +\cmakecommandandroidonly + +\section1 Synopsis + +\badcode +qt_android_generate_deployment_settings(target) +\endcode + +\versionlessCMakeCommandsNote qt6_android_generate_deployment_settings() + +\section1 Description + +The \c{androiddeployqt} tool expects a deployment settings file as input. This +command reads CMake variables and properties of the \c{target} to generate such +a file in the target's binary directory. Upon return, the full path to this file +is available in the target's \c{QT_ANDROID_DEPLOYMENT_SETTINGS_FILE} property. + +\section2 CMake Variables + +A number of variables are used while generating the deployment settings file. +Some are provided by Qt, others by CMake or the Android NDK. + +\list +\li \l{cmake-variable-ANDROID_NDK_HOST_SYSTEM_NAME}{ANDROID_NDK_HOST_SYSTEM_NAME} +\li \l{cmake-variable-ANDROID_SDK_ROOT}{ANDROID_SDK_ROOT} +\li \c{CMAKE_ANDROID_ARCH_ABI} +\li \c{CMAKE_ANDROID_NDK} +\li \c{CMAKE_SYSROOT} +\li \l{cmake-variable-QT_ANDROID_APPLICATION_ARGUMENTS}{QT_ANDROID_APPLICATION_ARGUMENTS} +\li \l{cmake-variable-QT_HOST_PATH}{QT_HOST_PATH} +\endlist + +\section2 Target Properties + +The properties below will be read from the specified \c{target}. Note that this +command is called as part of target finalization (see +\l{qt6_finalize_target}{qt_finalize_target()}). If you are using +\l{qt6_add_executable}{qt_add_executable()} to create the target and you need to +modify some of these target properties, you need to ensure that target +finalization is deferred. See \l{qt6_add_executable}{qt_add_executable()} for +how to accomplish this. + +\list +\li \l{cmake-target-property-QT_ANDROID_DEPLOYMENT_DEPENDENCIES}{QT_ANDROID_DEPLOYMENT_DEPENDENCIES} +\li \l{cmake-target-property-QT_ANDROID_EXTRA_LIBS}{QT_ANDROID_EXTRA_LIBS} +\li \l{cmake-target-property-QT_ANDROID_EXTRA_PLUGINS}{QT_ANDROID_EXTRA_PLUGINS} +\li \l{cmake-target-property-QT_ANDROID_MIN_SDK_VERSION}{QT_ANDROID_MIN_SDK_VERSION} +\li \l{cmake-target-property-QT_ANDROID_PACKAGE_SOURCE_DIR}{QT_ANDROID_PACKAGE_SOURCE_DIR} +\li \l{cmake-target-property-QT_ANDROID_TARGET_SDK_VERSION}{QT_ANDROID_TARGET_SDK_VERSION} +\li \l{cmake-target-property-QT_ANDROID_VERSION_NAME}{QT_ANDROID_VERSION_NAME} +\li \l{cmake-target-property-QT_ANDROID_VERSION_CODE}{QT_ANDROID_VERSION_CODE} +\li \l{cmake-target-property-QT_QML_IMPORT_PATH}{QT_QML_IMPORT_PATH} +\li \l{cmake-target-property-QT_QML_ROOT_PATH}{QT_QML_ROOT_PATH} +\li \l{cmake-target-property-qt_no_entrypoint}{qt_no_entrypoint} +\endlist + +Upon return, the \c{QT_ANDROID_DEPLOYMENT_SETTINGS_FILE} target property will +contain the location of the generated deployment settings file. + +\sa {qt6_android_add_apk_target}{qt_android_add_apk_target()}, + {qt6_finalize_target}{qt_finalize_target()} + +\section1 Example + +\snippet cmake-macros/examples.cmake qt_android_deploy_basic +*/ |