From eb4e9d9ee1c8f7c7cb21a627313378fe5926a3f2 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 8 Aug 2017 09:49:17 +0200 Subject: [PATCH] Doc: Make deprecated tools less prominent in Android instructions Ant was deprecated in Qt Creator 4.3 and will be removed. The sdkmanager and avdmanager command-line tools must be used to manage SDKs and AVDs. Change-Id: Ibba8bc429e5da87e3f79ce45766f4583d0a461b1 Reviewed-by: Vikas Pachdha --- doc/src/android/androiddev.qdoc | 69 ++++++++------------------ doc/src/android/deploying-android.qdoc | 5 +- 2 files changed, 25 insertions(+), 49 deletions(-) diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc index 5d57ce1beb..34cf3f7d6a 100644 --- a/doc/src/android/androiddev.qdoc +++ b/doc/src/android/androiddev.qdoc @@ -57,16 +57,14 @@ \li \l{http://www.oracle.com/technetwork/java/javase/downloads/index.html} {Java SE Development Kit (JDK)} version 6, or later - \li A build tool for building application packages for Android devices: + \li \l{http://www.gradle.org}{Gradle} for building application packages + for Android devices (APK). Gradle is delivered with Qt 5.9, and + later. - \list - - \li \l{http://ant.apache.org/bindownload.cgi}{Apache Ant} 1.8.0, - or later - - \li \l{http://www.gradle.org}{Gradle} - - \endlist + \note Using Ant to build APKs is still possible when developing with + Qt 5.8 or earlier together with Android SDK tools versions 25.2.5 or + earlier, but Ant support has been deprecated since \QC 4.3 and will + be removed in a future version. \li A tool chain for building applications for Android devices provided by the \l{http://developer.android.com/tools/sdk/ndk/index.html} @@ -74,20 +72,10 @@ \li \l{http://developer.android.com/sdk/index.html}{Android SDK Tools} - After installing the Tools, update the Android SDK to get the API - and tools packages required for development. You can use the - \l{http://developer.android.com/tools/help/android.html}{android} - tool that comes with the SDK Tools package. For example, on Ubuntu - the following command starts the SDK update: - - \code - ./android update sdk - \endcode - - \note The android tool is deprecated since SDK tools version 25.3.0. - Consider using + After installing the Tools, you can use the \l{https://developer.android.com/studio/command-line/sdkmanager.html} - {sdkmanager} instead. + {sdkmanager} to get the API and tools packages required for + development. \li On Windows, you also need the following: @@ -108,33 +96,17 @@ \endlist - \section1 Selecting the APK Build Tool - - On Android, applications are distributed in specially structured type of ZIP - packages called APK. You can use either Ant or Gradle to build APKs. Using - Gradle has the following benefits: - - \list - - \li It is 25 to 50 percent faster than Ant when rebuilding packages. - - \li It is delivered with Qt 5.9. - - \li It supports easily adding Android Extras libraries, such as - Google Play services or Android extension files (.obb) to your - project. - - \endlist - - \note Android SDK tools version 25.3.0 onwards do not contain Ant scripts - anymore. Therefore, Gradle builds are forced and you must use Qt 5.9 or - later when using these tools versions. - \section1 Setting Up the Development Environment You must download and install the latest Android NDK and SDK, and update the - SDK to get the API and tools packages needed for development. In addition, - you must install Qt for Android as part of Qt 5.2, or later. + SDK to get the build and platform tools needed for development. Since + SDK tools version 25.3.0, \QC, you must use the + \l{https://developer.android.com/studio/command-line/sdkmanager.html} + {sdkmanager} command line tool for SDK package management and the + \l{https://developer.android.com/studio/command-line/avdmanager.html} + {avdmanager} tool for Android Virtual Device (AVD) management. + + In addition, you must install Qt for Android as part of Qt 5.2, or later. For more information, see \l{Qt for Android}. @@ -165,6 +137,9 @@ \li To use Ant, add the path to the Ant executable in the \uicontrol {Ant executable} field. + \note Ant support has been deprecated since \QC 4.3. We + recommend that you use Gradle instead. + \endlist \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > @@ -213,7 +188,7 @@ \image qtcreator-android-select-devices.png "Select Android Devices dialog" - Android Virtual Devices (AVD) are also listed. To create new AVDs, select + AVDs are also listed. To create new AVDs, select \uicontrol {Create Android Virtual Device}. To set a device as the default device for a particular Android architecture, diff --git a/doc/src/android/deploying-android.qdoc b/doc/src/android/deploying-android.qdoc index 7d6f83ea8b..cf9018ce31 100644 --- a/doc/src/android/deploying-android.qdoc +++ b/doc/src/android/deploying-android.qdoc @@ -131,8 +131,9 @@ \endlist - The Gradle wrappers and scripts are bundled only if you use - \l{Selecting the APK Build Tool}{Gradle} to build the application packages. + The Gradle wrappers and scripts are bundled only if you use Gradle to build + the application packages. For more information, see + \l{Connecting Android Devices}. To view the packages that the \c androiddeployqt tool created, select the \uicontrol {Open package location after build} check box. -- GitLab