1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Android: update androiddeployqt doc page

Browse Source 
* Prioritize CMake snippets.
* Remove unrelated mention to various qmake variables.
* Mention the page for command line configuration and building
and remove the same duplicated command from this page.
* Mention the page for customizing the build from the Android docs.

Task-number: QTBUG-115020
Change-Id: I966c37661e17f6ffb8d25bfa3cd91e92be364e1d
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
(cherry picked from commit 5192de707d34b5ef3bcffdc8370a2f894ef647f2)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Assam Boudjelthia 2023-12-18 18:47:27 +02:00 committed by Qt Cherry-pick Bot
parent a91423d4ce
commit c4b1b97192
1 changed files with 32 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
src/tools/androiddeployqt/doc/src/androiddeployqt.qdoc
View File

@ -1,4 +1,4 @@
// Copyright (C) 2021 The Qt Company Ltd. // Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*! /*!
@ -7,64 +7,47 @@
\title The androiddeployqt Tool \title The androiddeployqt Tool
\target androiddeployqt \target androiddeployqt
Building an application package is complex, so Qt comes with a tool which Building an Android package involves many steps, so Qt comes with a tool which
handles the work for you. The steps described in handles the work for you. The steps handled by the androiddeployqt
\l{Deploying an Application on Android} are handled by the androiddeployqt tool are described in \l{Deploying an Application on Android}.
tool.
\section1 Prerequisites Before Running androiddeployqt \section1 Prerequisites Before Running androiddeployqt
Before running the tool manually, you need to run \c qmake or \c CMake Before running the tool manually, you need to configure your project with
on your project to generate \c Makefiles and a \c JSON file (i.e. \c CMake or \c qmake to generate \c Makefiles and a \c JSON file (i.e.
\c{android-project-deployment-settings.json}) containing important settings \c{android-<target_name>-deployment-settings.json}) containing important settings
used by \c androiddeployqt. used by \c androiddeployqt.
\note It is not recommended to modify the androiddeployqt JSON file. \note It is not recommended to modify the androiddeployqt JSON file.
To prepare the build for androiddeployqt, it is recommended to build your To prepare the environment for androiddeployqt, configure your project in
project in a separate directory. Run the following commands: a separate directory than your source directory. For more information on
configuring your project, see \l {Building Qt for Android Projects from Command Line}.
\badcode
mkdir build-project
cd build-project
\endcode
Followed by:
For qmake:
\badcode
qmake ../project/project.pro
make -j$(nproc)
make -j$(nproc) apk_install_target
\endcode
For CMake:
\badcode
cmake --build
\endcode
\section1 Command Line Arguments \section1 Command Line Arguments
The only required command line argument when running the tool is \c{--output}. The only required command line arguments when running the tool are
Other command line arguments are optional but useful. The list below is available \c {--input} and \c {--output}. Other command line arguments are optional but
by passing the \c{--help} argument to androiddeployqt. useful. The list below is available by passing the \c {--help} argument to
androiddeployqt.
\quotefromfile main.cpp \quotefromfile main.cpp
\skipto Syntax: androiddeployqt --output <destination> [options] \skipto Syntax: androiddeployqt --output <destination> [options]
\printuntil --help: Displays this information. \printuntil --help: Displays this information.
With a project named \c project, to directly build the application package With a \c project_name, to build the application package with \c androiddeployqt
with \c androiddeployqt without deploying it the device, run the following: without deploying it the device, run the following:
\badcode \badcode
androiddeployqt --input $BUILD_DIR/android-project-deployment-settings.json --output $ANDROID_BUILD_DIR androiddeployqt --input <build_dir>/android-project_name-deployment-settings.json \
--output <build_dir>/android-build
\endcode \endcode
To deploy the built package to the device: To build and deploy the package to the device:
\badcode \badcode
androiddeployqt --verbose --output $ANDROID_BUILD_DIR --no-build --input $BUILD_DIR/android-project-deployment-settings.json --gradle --reinstall --device <adb_device_id> androiddeployqt --input <build_dir>/android-project_name-deployment-settings.json \
--output <build_dir>/android-build --install --device <device_serial_id>
\endcode \endcode
\section1 Dependencies Detection \section1 Dependencies Detection
@ -76,11 +59,13 @@
dependencies based on the Qt dependencies of your application. If the plugin dependencies based on the Qt dependencies of your application. If the plugin
has any Qt dependencies which are not also dependencies of your application, has any Qt dependencies which are not also dependencies of your application,
it will not be included by default. For instance, in order to ensure that it will not be included by default. For instance, in order to ensure that
the SVG image format plugin is included, you will need to add \l{Qt SVG} the SVG image format plugin is included, you will need to add \l {Qt SVG}
module to your project for it to become a dependency of your application: module to your project for it to become a dependency of your application:
\badcode \badcode
QT += svg find_package(Qt6 REQUIRED COMPONENTS Svg)
...
target_link_libraries(target_name PRIVATE Qt6::Svg)
\endcode \endcode
If you are wondering why a particular plugin is not included automatically, If you are wondering why a particular plugin is not included automatically,
@ -91,7 +76,7 @@
\uicontrol {Advanced Actions}. \uicontrol {Advanced Actions}.
It's also possible to manually specify the dependencies of your application. It's also possible to manually specify the dependencies of your application.
For more information, see \l{ANDROID_DEPLOYMENT_DEPENDENCIES} qmake variable. For more information, see \l {QT_ANDROID_DEPLOYMENT_DEPENDENCIES} CMake variable.
\note androiddeployqt scans the QML files of the project to collect the QML imports. \note androiddeployqt scans the QML files of the project to collect the QML imports.
However, if you are loading QML code as a QString from C++ at runtime, that might However, if you are loading QML code as a QString from C++ at runtime, that might
@ -99,62 +84,12 @@
To remedy that, you can add a dummy QML file that imports such QML modules that To remedy that, you can add a dummy QML file that imports such QML modules that
are referenced at runtime. are referenced at runtime.
\section1 Android-specific qmake Variables
Unless the project has special requirements such as third party libraries,
it should be possible to run \l androiddeployqt on it with no modifications
and get a working Qt for Android application.
There are two important environment variables used by Qt:
\list
\li \c{ANDROID_SDK_ROOT}: specifies the path to the Android SDK used for
building the application. The Android SDK contains the build-tools,
Android NDK, and Android toolchains.
\li \c{ANDROID_NDK_ROOT}: specifies the path to the Android NDK used to
build the application. It is not recommended to hard-code this path,
since different Qt for Android versions can depend on different
Android NDK versions.
\endlist
\note Qt Creator sets these variables by default.
There are a set of \c qmake or \c CMake variables that can be used to tailor
your package. At some point during development, you will most likely want
to look into these variables to customize your application.
Here is a list of some variables that are particularly interesting when
making Android applications:
\list
\li \l{ANDROID_PACKAGE_SOURCE_DIR}
\li \l{ANDROID_VERSION_CODE}
\li \l{ANDROID_VERSION_NAME}
\li \l{ANDROID_EXTRA_LIBS}
\li \l{ANDROID_EXTRA_PLUGINS}
\li \l{ANDROID_ABIS}
\li \l{ANDROID_API_VERSION}
\li \l{ANDROID_DEPLOYMENT_DEPENDENCIES}
\li \l{ANDROID_MIN_SDK_VERSION}
\li \l{ANDROID_TARGET_SDK_VERSION}
\li \l{JAVA_HOME}
\endlist
Also, the following \c qmake variables are primarily useful when writing a Qt module, and not
normal applications:
\list
\li \l{ANDROID_BUNDLED_JAR_DEPENDENCIES}
\li \l{ANDROID_LIB_DEPENDENCIES}
\li \l{ANDROID_PERMISSIONS}
\li \l{ANDROID_FEATURES}
\endlist
\note This list of variables can also be used with CMake.
\section1 Deployment in Qt Creator \section1 Deployment in Qt Creator
Qt Creator runs \c androiddeployqt by default, and provides easy Qt Creator uses \c androiddeployqt under the hood, and provides easy
and intuitive user interfaces to specify many of the options. For more and intuitive user interfaces to specify various options. For more information,
information, see \l{Qt Creator: Deploying Applications to Android Devices}. see \l{Qt Creator: Deploying Applications to Android Devices}.
For more information about customizing and deploying a Qt for Android app,
see \l {Deploying an Application on Android}.
*/ */