diff --git a/docs/html/guide/developing/index.jd b/docs/html/guide/developing/index.jd index 4257bf04ef4cd..3d7e35351b2a1 100644 --- a/docs/html/guide/developing/index.jd +++ b/docs/html/guide/developing/index.jd @@ -9,25 +9,21 @@ page.title=Introduction

However, you may choose to develop with another IDE or a simple text editor and invoke the tools on the command line or with scripts. This is a less streamlined way to develop because you will sometimes have to call command line tools manually, but you will have access to the same - amount of features that you would have in Eclipse.

+ number of features that you would have in Eclipse.

+ +

Note: Before you begin developing Android applications, make + sure you have gone through all of the steps outlined in Installing the SDK.

The basic steps for developing applications with or without Eclipse are the same:

    -
  1. Install Eclipse or your own IDE. - -

    Install Eclipse along with the ADT - Plugin, or install an editor of your choice if you want to use the command line SDK tools. - If you are already developing applications, be sure to update Your ADT Plugin to the latest version - before continuing.

    -
  2. Set up Android Virtual Devices or hardware devices.

    You need to create Android Virtual Devices (AVD) or connect hardware devices on which you will install your applications.

    - +

    See Managing Virtual Devices and Using Hardware Devices for more information. diff --git a/docs/html/guide/developing/tools/index.jd b/docs/html/guide/developing/tools/index.jd index c60378020cc2e..3d831f3e390cb 100644 --- a/docs/html/guide/developing/tools/index.jd +++ b/docs/html/guide/developing/tools/index.jd @@ -3,83 +3,83 @@ page.title=Tools -

    The Android SDK includes a variety of custom tools that help you develop mobile -applications on the Android platform. The most important of these are the Android -Emulator and the Android Development Tools plugin for Eclipse, but the SDK also -includes a variety of other tools for debugging, packaging, and installing your -applications on the emulator.

    +

    The Android SDK includes a variety of tools that help you develop mobile +applications for the Android platform. The tools are classified into two groups: SDK tools +and platform tools. SDK tools are platform independent and are required no matter which +Android platform you are developing on. Platform tools are customized to support the features of the +latest Android platform.

    -
    -
    Android Debug Bridge
    -
    A versatile tool lets you manage the state of an emulator instance - or Android-powered device.
    - -
    android
    -
    Lets you manage AVDs, projects, and the installed components of the SDK. -
    - -
    bmgr
    - -
    Lets you interact with the Backup Manager on Android devices - supporting API Level 8 or greater. It provides commands to invoke backup and restore operations - so that you don't need to repeatedly wipe data or take similar intrusive steps in order to test - your application's backup agent. These commands are accessed via the adb shell. -
    +

    SDK Tools

    +

    The SDK tools are installed with the SDK starter package and are periodically updated. +The SDK tools are required if you are developing Android applications. The most important SDK tools +include the Android SDK and AVD Manager (android), the emulator +(emulator), and the Dalvik Debug Monitor Server +(ddms). A short summary of some frequently-used SDK tools is provided below.

    +
    +
    android
    +
    Lets you manage AVDs, projects, and the installed components of the SDK.
    +
    Dalvik Debug Monitor +Server (ddms)
    +
    Lets you debug Android applications.
    dmtracedump
    - -
    Generates graphical call-stack diagrams from trace log files. - The tool uses the Graphviz Dot utility to create the graphical output, so you need to install - Graphviz before running dmtracedump. For more information on using dmtracedump, see - Profiling with - Traceview and dmtracedump -
    - -
    Draw 9-patch
    -
    Allows you to easily create a {@link android.graphics.NinePatch} graphic using a WYSIWYG editor. - It also previews stretched versions of the image, and highlights the area in which content is allowed. -
    - -
    Android Emulator
    -
    A QEMU-based device-emulation tool that you can use to design, - debug, and test your applications in an actual Android run-time environment.
    - +
    Generates graphical call-stack diagrams from trace log files. The tool uses the +Graphviz Dot utility to create the graphical output, so you need to install Graphviz before +running dmtracedump. For more information on using dmtracedump, see Profiling +with Traceview and dmtracedump
    +
    Draw 9-patch
    +
    Allows you to easily create a {@link android.graphics.NinePatch} graphic using a +WYSIWYG editor. It also previews stretched versions of the image, and highlights the area in which +content is allowed.
    +
    Android Emulator (emulator)
    +
    A QEMU-based device-emulation tool that you can use to design, debug, and test +your applications in an actual Android run-time environment.
    +
    Hierarchy Viewer (hierarchyviewer)
    +
    Lets you debug and optimize an Android application's user interface.
    hprof-conv
    - -
    Converts the HPROF file that is generated by the Android SDK tools to a - standard format so you can view the file in a profiling tool of your choice.
    - +
    Converts the HPROF file that is generated by the Android SDK tools to a standard format so +you can view the file in a profiling tool of your choice.
    layoutopt
    -
    Lets you quickly analyze your application's layouts in order to - optimize them for efficiency. -
    - -
    logcat
    -
    Lets you read system log messages that are output on an Android device or emulator.
    - +
    Lets you quickly analyze your application's layouts in order to optimize them for +efficiency.
    mksdcard
    -
    Helps you create a disk image that you can use with the emulator, - to simulate the presence of an external storage card (such as an SD card).
    - +
    Helps you create a disk image that you can use with the emulator, to simulate the presence +of an external storage card (such as an SD card).
    Monkey
    -
    Runs on your emulator or device and generates pseudo-random - streams of user events such as clicks, touches, or gestures, as well as a number of system-level events. - You can use the Monkey to stress-test applications that you are developing, in a random yet repeatable manner.
    - +
    Runs on your emulator or device and generates pseudo-random streams of user events such +as clicks, touches, or gestures, as well as a number of system-level events. You can use the Monkey +to stress-test applications that you are developing, in a random yet repeatable manner.
    monkeyrunner
    -
    Provides an API for writing programs that control an Android device - or emulator from outside of Android code.
    - +
    Provides an API for writing programs that control an Android device or emulator from +outside of Android code.
    ProGuard
    -
    Shrinks, optimizes, and obfuscates your code by removing unused code and renaming classes, - fields, and methods with semantically obscure names.
    - +
    Shrinks, optimizes, and obfuscates your code by removing unused code and renaming +classes, fields, and methods with semantically obscure names.
    sqlite3
    -
    Lets you access the SQLite data files created and used by Android applications.
    - +
    Lets you access the SQLite data files created and used by Android applications.
    +
    traceview
    +
    Provides a graphical viewer for execution logs saved by your application.
    zipalign
    -
    Optimizes .apk files by ensuring that all uncompressed data starts - with a particular alignment relative to the start of the file. This should always be used - to align .apk files after they have been signed.
    -
    +
    Optimizes .apk files by ensuring that all uncompressed data starts with a +particular alignment relative to the start of the file. This should always be used to align .apk +files after they have been signed.
    +
    +

    Platform Tools

    + +

    The platform tools are typically updated every time you install a new SDK platform. Each update +of the platform tools is backward compatible with older platforms. Usually, you directly use only +one of the platform tools—the Android Debug Bridge (adb). +Android Debug Bridge is a versatile tool that lets you manage the state of an emulator instance or +Android-powered device. You can also use it to install an Android application (.apk) file on a +device.

    + +

    The other platform tools, such as aidl, +aapt, dexdump, and dx, are typically called by the Android +build tools or Android Development Tools (ADT), so you rarely need to invoke these tools directly. +As a general rule, you should rely on the build tools or the ADT plugin to call them as needed.

    + +

    Note: The Android SDK provides additional shell tools that can +be accessed through adb, such as bmgr and +logcat.

    \ No newline at end of file diff --git a/docs/html/sdk/eclipse-adt.jd b/docs/html/sdk/eclipse-adt.jd index ece9d4ae0c023..feb84b1175cc1 100644 --- a/docs/html/sdk/eclipse-adt.jd +++ b/docs/html/sdk/eclipse-adt.jd @@ -656,7 +656,7 @@ ADT installation as described in the steps below.

    Downloading the ADT Plugin

    Use the Update Manager feature of your Eclipse installation to install the latest -revision of ADT on your development computer.

    +revision of ADT on your development computer.<>

    Assuming that you have a compatible version of the Eclipse IDE installed, as described in Preparing for Installation, above, follow @@ -671,26 +671,32 @@ Software....

  3. In the Add Repository dialog that appears, enter "ADT Plugin" for the Name and the following URL for the Location:
    https://dl-ssl.google.com/android/eclipse/
    -

    Note: If you have trouble acquiring the plugin, try using "http" in the Location URL, - instead of "https" (https is preferred for security reasons).

    -

    Click OK.

  4. -
  5. In the Available Software dialog, select -the checkbox next to Developer Tools and click Next.
  6. + +
  7. Click OK +

    Note: If you have trouble acquiring the plugin, try using "http" in the Location URL, +instead of "https" (https is preferred for security reasons).

  8. +
  9. In the Available Software dialog, select the checkbox next to Developer Tools and click +Next.
  10. In the next window, you'll see a list of the tools to be downloaded. Click Next.
  11. -
  12. Read and accept the license agreements, then click Finish.
  13. +
  14. Read and accept the license agreements, then click Finish. +

    Note: If you get a security warning saying that the authenticity or validity of +the software can't be established, click OK.

  15. When the installation completes, restart Eclipse.

Configuring the ADT Plugin

-

Once you've successfully downloaded ADT as described above, the next step +

After you've successfully downloaded the ADT as described above, the next step is to modify your ADT preferences in Eclipse to point to the Android SDK directory:

  1. Select Window > Preferences... to open the Preferences panel (Mac OS X: Eclipse > Preferences).
  2. -
  3. Select Android from the left panel.
  4. +
  5. Select Android from the left panel.
  6. +

    You may see a dialog asking whether you want to send usage statistics to Google. If so, +make your choice and click Proceed. You cannot continue with this procedure until +you click Proceed.

  7. For the SDK Location in the main panel, click Browse... and locate your downloaded SDK directory.
  8. Click Apply, then OK.
  9. diff --git a/docs/html/sdk/installing.jd b/docs/html/sdk/installing.jd index a1080c2c1a67b..1dce483c273b8 100644 --- a/docs/html/sdk/installing.jd +++ b/docs/html/sdk/installing.jd @@ -81,9 +81,9 @@ this page.

    Updating?

    -

    If you already have an Android SDK, use the Android SDK and AVD Manager tool to install +

    If you already have an Android SDK, use the Android SDK and AVD Manager tool to install updated tools and new Android platforms into your existing environment. For information about how to -do that, see Adding SDK Components

    +do that, see Adding SDK Components.

    Step 1. Preparing Your Development Computer

    @@ -126,7 +126,7 @@ install the SDK Tools into a default location (which you can modify).

    Make a note of the name and location of the SDK directory on your system—you will need to refer to the SDK directory later, when setting up the ADT plugin and when using -the SDK tools from command line.

    +the SDK tools from the command line.

    Step 3. Installing the ADT Plugin for Eclipse

    @@ -147,26 +147,25 @@ step-by-step installation instructions, then return here to continue the last step in setting up your Android SDK.

    If you prefer to work in a different IDE, you do not need to -install Eclipse or ADT, instead, you can directly use the SDK tools to build and -debug your application. The Overview -section of the developer guide outlines the major steps that you need to complete -when developing in Eclipse or other IDEs.

    +install Eclipse or ADT. Instead, you can directly use the SDK tools to build and +debug your application. The Introduction +to Android application development outlines the major steps that you need to complete when +developing in Eclipse or other IDEs.

    Step 4. Adding Platforms and Other Components

    -

    The last step in setting up your SDK is using the Android SDK and AVD Manager (a -tool included in the SDK starter package) to download -essential SDK components into your development environment.

    +

    The last step in setting up your SDK is using the Android SDK and AVD Manager (a +tool included in the SDK starter package) to download essential SDK components into your development +environment.

    The SDK uses a modular structure that separates the major parts of the SDK—Android platform versions, add-ons, tools, samples, and documentation—into a set of separately installable components. The SDK starter package, which you've already downloaded, includes only a single -component: the latest version of the SDK Tools. To develop an Android -application, you also need to download at least one Android platform and the SDK Platform-tools -(tools that the latest platform depend upon). However, downloading -additional components is highly recommended.

    +component: the latest version of the SDK Tools. To develop an Android application, you also need to +download at least one Android platform and the associated platform tools. You can add other +components and platforms as well, which is highly recommended.

    If you used the Windows installer, when you complete the installation wizard, it will launch the Android SDK and AVD Manager with a default set of platforms and other components selected @@ -185,10 +184,10 @@ Android SDK, then execute:

    android

    To download components, use the graphical UI of the Android SDK and AVD -Manager, shown in Figure 1, to browse the SDK repository and select new or updated -components. The Android SDK and AVD Manager will install the selected components in -your SDK environment. For information about which components you should download, see the following -section about Recommended Components.

    +Manager to browse the SDK repository and select new or updated +components (see figure 1). The Android SDK and AVD Manager installs the selected components in +your SDK environment. For information about which components you should download, see Recommended Components.

    Figure 1. The Android SDK and AVD Manager's @@ -204,35 +203,34 @@ Repository and Third party Add-ons.

    The Android Repository offers these types of components: