[
https://issues.apache.org/jira/browse/CB-10332?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15131314#comment-15131314
]
ASF GitHub Bot commented on CB-10332:
-------------------------------------
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/471#discussion_r51802258
--- Diff: www/docs/en/dev/guide/platforms/android/index.md ---
@@ -32,276 +32,152 @@ development. For a comparison of the two development
paths, see the
## Requirements and Support
+### Java Development Kit (JDK)
+
+Install [Java Development Kit (JDK)
7](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html)
+or later.
+
+When installing on Windows you also need to set `JAVA_HOME` Environment
Variable
+according to JDK installation path (for example, `C:\Program
Files\Java\jdk1.7.0_75`).
+
+### Android SDK
+
Cordova for Android requires the Android SDK which could be installed
on OS X, Linux or Windows operation system. See the Android SDK's
[System
Requirements](http://developer.android.com/sdk/index.html#Requirements).
-
-Cordova supports Android 4.0.x (starting with Android API level 14)
-and higher. As a general rule, Android versions become unsupported by
Cordova as
+Cordova's latest Android package supports up to Android
[API-Level](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
23.
+The supported Android API-Levels for the past few cordova-android releases
can
+be found in this table:
+
+cordova-android Version | Supported Android API-Levels
+------------------------|-----------------------------
+5.X.X | 14 - 23
+4.1.X | 14 - 22
+4.0.X | 10 - 22
+3.7.X | 10 - 21
+
+Please note that the versions listed here are for Cordova's Android
package,
+[cordova-android](https://github.com/apache/cordova-android), and not for
the
+Cordova CLI. To determine what version of Cordova's Android package is
installed
+in your Cordova project, run the command `cordova platform ls` in the
directory
+that holds your project.
+
+As a general rule, Android versions become unsupported by Cordova as
they dip below 5% on Google's
[distribution
dashboard](http://developer.android.com/about/dashboards/index.html).
-Android versions earlier than API level 10, and the 3.x versions
(Honeycomb,
-API levels 11-13) fall significantly below that 5% threshold.
-
-## Install Cordova Shell Tools
-
-If you want to use Cordova's Android-centered shell tools in
-conjunction with the SDK, download Cordova from
-[cordova.apache.org](http://cordova.apache.org). Otherwise ignore this
-section if you plan to use the cross-platform CLI tool described in
-[The Command-Line Interface](../../cli/index.html).
-The Cordova download contains separate archives for each platform. Be
-sure to expand the appropriate archive, `android` in this case, within
-an empty directory. The relevant executible utilities are available
-in the top-level `bin` directory. (Consult the __README__ file if
-necessary for more detailed directions.)
+#### Installing the Android SDK
-These shell tools allow you to create, build, and run Android apps.
-For information on the additional command-line interface that enables
-plugin features across all platforms, see Using Plugman to Manage
-Plugins. See Application Plugins for details on how to develop
-plugins.
-
-## Install the Java Development Kit (JDK)
-
-Install [Java Development Kit (JDK)
7](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html)
-or later.
-
-When installing on Windows you also need to set `JAVA_HOME` Environment
Variable
-according to JDK installation path (for example, C:\Program
Files\Java\jdk1.7.0_75).
-
-## Install the Android SDK
-
-Install the [Android Stand-alone SDK
Tools](http://developer.android.com/sdk/installing/index.html?pkg=tools) or
[Android
Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio).
Procceed with `Android Studio` if you plan
+Install the [Android Stand-alone SDK
Tools](http://developer.android.com/sdk/installing/index.html?pkg=tools) or
[Android
Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio).
+Proceed with Android Studio if you plan on
developing new Cordova for Android plugins or using native tools to
-run and debug Android platform. Otherwise, `Android Stand-alone SDK Tools`
-are enough to build and deploy Android application.
+run and debug the Android platform. Otherwise, the Android Stand-alone SDK
Tools
+are enough to build and deploy Android applications.
Detailed installation instructions are available as part of installation
links above.
-For Cordova command-line tools to work, or the CLI that is based upon
-them, you need to include the SDK's `tools` and `platform-tools`
-directories in your `PATH`. On a Mac or Linux, you can use a text editor
to
-create or modify the `~/.bash_profile` file, adding a line such as the
-following, depending on where the SDK installs:
+#### Update your PATH
+
+For Cordova's CLI and command line tools to work correctly, you will need
to
+include the SDK's `tools` and `platform-tools` directories in your `PATH`.
+
+##### OS X and Linux
+
+On a Mac or Linux, you can use a text editor to create or modify the
+`~/.bash_profile` file, adding a line such as the following
+(substitute the paths with your local Android SDK installation's location):
export
PATH=${PATH}:/Development/android-sdk/platform-tools:/Development/android-sdk/tools
-This line in `~/.bash_profile` exposes these tools in newly opened terminal
-windows. If your terminal window is already open in OSX, or to avoid a
logout/login
-on Linux, run this to make them available in the current terminal window:
+Reload your terminal to see this change reflected or run the following
command:
$ source ~/.bash_profile
-To modify the `PATH` environment on Windows:
+##### Windows
+
+On Windows, you must modify the `PATH` environment variable. These steps
may
+vary depending on your installed version of Windows:
-1. Click on the __Start__ menu in the lower-left corner of the desktop,
- right-click on __Computer__, then select __Properties__.
+1. Click on the __Start__ menu in the lower-left corner of the desktop
-1. Select __Advanced System Settings__ in the column on the left.
+1. In the search bar, search for __Environment Variables__ and select
__Edit the system Environment Variables__ from the options that appear
-1. In the resulting dialog box, press __Environment Variables__.
+1. In the window that appears, click the __Environment Variables__ button
1. Select the __PATH__ variable and press __Edit__.
-1. Append the following to the `PATH` based on where you installed the
- SDK, for example:
+1. Append the relevant locations to the __PATH__ based on where you
installed
+ the SDK, for example:
;C:\Development\android-sdk\platform-tools;C:\Development\android-sdk\tools
1. Save the value and close both dialog boxes.
-## Install SDK Packages
-
-Open Android SDK Manager (for example, via terminal: `android`) and
install:
-
-1. Android 5.1.1 (API 22) platform SDK
-1. Android SDK Build-tools version 19.1.0 or higher
-1. Android Support Repository (Extras)
-
-See [Installing SDK
Packages](http://developer.android.com/sdk/installing/adding-packages.html)
-for more details.
-
-## Configure an Emulator
-
-Android sdk doesn't provide any default emulator instance by default. You
can
-create a new one by running `android` on the command line.
-The press __Tools → Manage AVDs__ (Android Virtual Devices),
-then choose any item from __Device Definitions__ in the resulting dialog
-box:
-
-
-
-Press __Create AVD__, optionally modifying the name, then press __OK__
-to accept the changes:
-
-
-
-The AVD then appears in the __Android Virtual Devices__ list:
-
-
-
-To open the emulator as a separate application, select the AVD and
-press __Start__. It launches much as it would on the device, with
-additional controls available for hardware buttons:
-
-
-
+1. Close and reopen any command prompt windows to see the change reflected
-For a faster experience, you can use the `Virtual Machine Acceleration` to
improve
-the execution speed.
-Many modern CPUs provide extensions to execute Virtual Machines more
efficiently.
-Before attempting to use this type of acceleration, you need to determine
if your
-current development system's CPU, supports one the following
virtualization technologies:
+#### Adding SDK Packages
-* __Intel Virtualization Technology__ (VT-x, vmx) → [Intel VT-x
supported processor
list](http://ark.intel.com/products/virtualizationtechnology)
-* __AMD Virtualization__ (AMD-V, SVM), only supported for Linux (Since May
2006, all CPUs AMD include AMD-V, except Sempron).
+After installing the Android SDK, you must also install the packages for
+whatever [API
level](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
+you wish to target. It is recommended that you install the highest SDK
version
+that your version of cordova-android supports (see above).
-Another way to find out if your Intel processor supports VT-x Technology,
it's by executing the
-`Intel Processor Identification Utility`, for `Windows`you can download it
from the Intel [Download
Center](https://downloadcenter.intel.com/Detail_Desc.aspx?ProductID=1881&DwnldID=7838),
-or you can use the [booteable
utility](https://downloadcenter.intel.com/Detail_Desc.aspx?ProductID=1881&DwnldID=7840&lang=eng),
which is `OS Independent`.
+Open Android SDK Manager (for example, run `android` from the terminal)
and make
+sure the following are installed:
-After install and execute the `Intel Processor Identification Utility`
over Windows, you will get the following window,
-in order to check if your CPU supports the Virtualization Technologies:
-
-
-
-In order to speed up the emulator, you need to download and install one or
more `Intel x86 Atom` System Images,
-as well as the `Intel Hardware Accelerated Execution Manager (HAXM)`.
-
-Open your Android SDK Manager, and select the `Intel x86 Atom` System
Image, for whichever version that you want to test. Then go to `Extras`
-and select `Intel x86 Emulator Accelerator (HAXM)`, and install those
packages:
-
-
-
-After download, run the Intel installer, which is available within your
-Android SDK at `extras/intel/Hardware_Accelerated_Execution_Manager`.
-__Note__:`If you have any problems installing the package, you can find
more information and step by step guidance check this`
-[Intel
Article](http://software.intel.com/en-us/android/articles/speeding-up-the-android-emulator-on-intel-architecture).
-
-1. Install one or more `Intel x86 Atom` System Images as well as the
- `Intel Hardware Accelerated Execution Manager`, available under
- __Extras__.
-
-1. Run the Intel installer, which is available within your Android SDK
- at `extras/intel/Hardware_Accelerated_Execution_Manager`.
-
-1. Create a new AVD with the target set to an Intel image.
-
-1. When starting the emulator, ensure there are no error messages
- indicating a failure to load HAX modules.
-
-## Create a New Project
-
-At this point, to create a new project you can choose between the
-cross-platform CLI tool described in [The Command-Line
Interface](../../cli/index.html), or
-the set of Android-specific shell tools. From within a source-code
-directory, here's the CLI approach:
-
- $ cordova create hello com.example.hello HelloWorld
- $ cd hello
- $ cordova platform add android
- $ ccordova prepare # or "cordova build"
-
-Here's the corresponding lower-level shell-tool approach for both Unix
-and Windows:
-
- $ /path/to/cordova-android/bin/create /path/to/new/hello
com.example.hello HelloWorld
- C:\path\to\cordova-android\bin\create.bat C:\path\to\new\hello
com.example.hello HelloWorld
-
-## Build the Project
-
-If you are using the CLI in development, the project directory's
-top-level `www` directory contains the source files. Run any of
-these within the project directory to rebuild the app:
-
- $ cordova build # build all platforms that were
added
- $ cordova build android # build debug for only Android
- $ cordova build android --debug # build debug for only Android
- $ cordova build android --release # build release for only Android
-
-If you are using the Android-specific shell tools in development,
-there is a different approach. Once you generate the project, the
-default app's source is available in the `assets/www` subdirectory.
-Subsequent commands are available in its `cordova` subdirectory.
-
-The `build` command cleans project files and rebuilds the app. Here is
-the syntax for both Mac and Windows. The first pair of examples
-generate debugging information, and the second builds the apps for
-release:
-
- $ /path/to/project/cordova/build --debug
- C:\path\to\project\cordova\build.bat --debug
-
- $ /path/to/project/cordova/build --release
- C:\path\to\project\cordova\build.bat --release
-
-## Deploy the app
-
-You can use the `cordova` CLI utility to deploy the
-application to the emulator or the device from the command line:
-
- $ cordova emulate android #to deploy the app on a default
android emulator
- $ cordova run android --device #to deploy the app on a connected
device
-
-Otherwise, use the alternate shell interface:
-
- $ /path/to/project/cordova/run --emulator
- $ /path/to/project/cordova/run --device
-
-You can use __cordova run android --list__ to see all available targets
and
-__cordova run android --target=target_name__ to run application on a
specific
-device or emulator (for example, `cordova run android
--target="Nexus4_emulator"`).
-
-You can also use __cordova run --help__ to see additional build and run
-options.
-
-This pushes the app to the home screen and launches it:
+1. Android Platform SDK for your targeted version of Android
+1. Android SDK Build-tools version 19.1.0 or higher
+1. Android Support Repository (found under "Extras")
-
+See Android's documentation on [Installing SDK
Packages](http://developer.android.com/sdk/installing/adding-packages.html)
+for more details.
-When you `run` the app, you also `build` it. You can append additional
-`--debug`, `--release`, and `--nobuild` flags to control how it is
-built, or even whether a rebuild is necessary:
+## Setting up an Emulator
- $ /path/to/project/cordova/run --emulator --nobuild
+If you wish to run your Cordova app on an Android emulator, you will first
need
+to create an Android Virtual Device (AVD). See the Android documentation
for
+[managing
AVDs](http://developer.android.com/tools/devices/managing-avds.html)
+and the
[instructions](http://developer.android.com/tools/devices/emulator.html)
+for configuring the emulator and setting up hardware acceleration.
-## Other Commands
+Once your AVD is configured correctly, you should be able to see it by
running
+the command:
-The following generates a detailed log of the app as it runs:
+ $ cordova run --list
--- End diff --
Can we list the expected output?
> Improve Android Guide
> ---------------------
>
> Key: CB-10332
> URL: https://issues.apache.org/jira/browse/CB-10332
> Project: Apache Cordova
> Issue Type: Task
> Components: Docs
> Reporter: Raghav
> Assignee: Richard B Knoll
> Labels: Docs-6.x
>
> We did a document scrub and found the following issues. Please feel free to
> correct other things as well.
> - Android Platform Guide
> -- Install Cordova Shell tools is out of date
> -- Environment variable instructions for Windows are out of date
> -- Emulator section can just point to
> http://developer.android.com/tools/devices/emulator.html
> -- Lots of duplicated content for create/build/deploy from CLI page
> -- Page keeps switching between CLI and platform-centric workflow
> - Android Shell Tool Guide
> -- Second paragraph is out of date
> -- Create/build/run/logging/clean should be clear that this is the
> platform-centric workflow. Also duplicated in Android Platform guide
> -- Platform-centric workflow should probably just get its own explicit page
> -- Signing an app doesn't actually say how to sign an app. Gives arguments
> for some mystery command
> --- Does this belong in our docs? We might just mention it and point to
> Google's app signing instructions
> - Android WebViews
> -- Needs investigation if this is still supported.
> --- Step 1 is wrong (should be getting cordova-android by cloning or from npm)
> --- Step 3 needs to have instructions for adding jars to gradle
> --- Step 5 is out of date. CordovaActivity does not implement
> CordovaInterface... Think they should be extending/modifying CordovaActivity.
> Needs investigation
> --- Step 6 does not appear to be camera plugin specific
> --- Step 7 example is useless, it needs to be fleshed out
> - Android plugins
> -- Should be moved to plugin developer docs
> -- Need a reference for the classes that plugins have access to
> --- CordovaWebView, CallbackContext, CordovaPlugin, etc.
> --- Most already have javadoc
> -- Android Integration should be renamed and link to the Android classes it's
> talking about
> -- Debugging Android plugins is out of date (mentions Eclipse and jars) and
> should probably be fleshed out a bit
> - Android Configuration
> -- Should be a reference
> - Upgrading Android
> -- Ends at 4.0.0 (current is 4.1.1, soon to be 5.0.0)
> -- Needs to be reorganized in some way
> --- The instructions seem to be pretty much the same for versions 1.6.0 +
> -- Goes back to the phonegap days! Should probably only include Cordova
> versions (1.5.0 +)
> -- Upgrade to 1.8.0 from 1.7.0 repeated twice
> -- Upgrade to 1.8.0 from 1.8.0 is a typo
> General guidelines:
> - While giving examples, keep them short. Do not repeat for all
> plugins/platforms.
> - Remove all references to cordova plugin registry.
> - Remove Tizen references. The platform is deprecated
> (http://markmail.org/message/hryg6sjswecpgndu)
> - Keep information up to date for the platforms, CLI and plugins
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
