From 4623c0d842403bf2ae4b622590325c3635aaf563 Mon Sep 17 00:00:00 2001 From: Scott Main Date: Wed, 7 Nov 2012 11:08:01 -0800 Subject: [PATCH] docs: Add basic tool help pages for SDK and AVD Manager. The SDK Manager page is needed particularly as a reference by some pages rather than pointing to the installation guide. Change-Id: Ie835e310f62cdc88bd6318e82f48e36bdd8e117a --- docs/html/tools/devices/managing-avds.jd | 5 +- docs/html/tools/help/avd-manager.jd | 19 +++++++ docs/html/tools/help/sdk-manager.jd | 67 ++++++++++++++++++++++++ docs/html/tools/tools_toc.cs | 2 + 4 files changed, 91 insertions(+), 2 deletions(-) create mode 100644 docs/html/tools/help/avd-manager.jd create mode 100644 docs/html/tools/help/sdk-manager.jd diff --git a/docs/html/tools/devices/managing-avds.jd b/docs/html/tools/devices/managing-avds.jd index 412bd913d613b..10633d264fca0 100644 --- a/docs/html/tools/devices/managing-avds.jd +++ b/docs/html/tools/devices/managing-avds.jd @@ -20,8 +20,9 @@ parent.link=index.html

The AVD Manager is an easy to use user interface to manage your AVD (Android Virtual Device) configurations. An AVD is a device configuration for the Android emulator that allows you to model different configurations of Android-powered devices. When you start the AVD Manager in Eclipse - or run the android tool on the command line, you will see the AVD Manager as shown in - figure 1:

+ or navigate to your SDK's {@code tools/} directory and execute + android avd. You will see the AVD Manager as shown in + figure 1.

diff --git a/docs/html/tools/help/avd-manager.jd b/docs/html/tools/help/avd-manager.jd new file mode 100644 index 0000000000000..ed90f433978d6 --- /dev/null +++ b/docs/html/tools/help/avd-manager.jd @@ -0,0 +1,19 @@ +page.title=AVD Manager +@jd:body + + +

The AVD Manager provides a graphical user interface in which you can create +and manage Android Virtual Devices (AVDs), which are required by the +Android Emulator.

+ +

You can launch the AVD Manager in one of the following ways:

+ + +

For more information, see Managing +AVDs with AVD Manager. diff --git a/docs/html/tools/help/sdk-manager.jd b/docs/html/tools/help/sdk-manager.jd new file mode 100644 index 0000000000000..4852b21fcafb0 --- /dev/null +++ b/docs/html/tools/help/sdk-manager.jd @@ -0,0 +1,67 @@ +page.title=SDK Manager +@jd:body + + +

The Android SDK separates tools, platforms, and other components into packages you can + download using the SDK Manager.

+ +

You can launch the SDK Manager in one of the following ways:

+ + +

You can select which packages you want to download by toggling the checkboxes on the left, then +click Install to install the selected packages.

+ + +

Figure 1. The Android SDK Manager shows the +SDK packages that are available, already installed, or for which an update is available.

+ + + + +

Here's an outline of the packages required and those we recommend you use: +

+ +
+
SDK Tools
+
Required. Your new SDK installation already has the latest version. Make sure +you keep this up to date.
+
SDK Platform-tools
+
Required. You must install this package when you install the SDK for +the first time.
+
SDK Platform
+
Required.You must download at least one platform into your +environment so you're able to compile your application. In order to provide the best user experience +on the latest devices, we recommend that you use the latest platform version as your build target. +You'll still be able to run your app on older versions, but you must build against the latest +version in order to use new features when running on devices with the latest version of Android. +

To get started, download the latest Android version, plus the lowest version you plan + to support (we recommend Android 2.2 for your lowest version).

+
System Image
+
Recommended. Although you might have one or more Android-powered devices on which to test + your app, it's unlikely you have a device for every version of Android your app supports. It's +a good practice to download system images for all versions of Android your app supports and test +your app running on them with the Android emulator.
+
Android Support
+
Recommended. Includes a static library that allows you to use some of the latest +Android APIs (such as fragments, +plus others not included in the framework at all) on devices running +a platform version as old as Android 1.6. All of the activity templates available when creating +a new project with the ADT Plugin +require this. For more information, read Support Library.
+
SDK Samples
+
Recommended. The samples give you source code that you can use to learn about +Android, load as a project and run, or reuse in your own app. Note that multiple +samples packages are available — one for each Android platform version. When +you are choosing a samples package to download, select the one whose API Level +matches the API Level of the Android platform that you plan to use.
+
+ +

Tip: For easy access to the SDK tools from a command line, add the +location of the SDK's tools/ and +platform-tools to your PATH environment variable.

diff --git a/docs/html/tools/tools_toc.cs b/docs/html/tools/tools_toc.cs index cca9433bd1925..128d320245b82 100644 --- a/docs/html/tools/tools_toc.cs +++ b/docs/html/tools/tools_toc.cs @@ -135,6 +135,7 @@ class="en">Tools Help
  • adb
  • ADT
  • android
    • +
  • AVD Manager
  • bmgr
  • Device Monitor
  • dmtracedump
    • @@ -160,6 +161,7 @@ class="en">MonkeyRunner
  • ProGuard
    • +
  • SDK Manager
  • Systrace
  • Tracer for OpenGL ES
  • Traceview