diff --git a/Android.mk b/Android.mk index 2e2fec18ac165..49ee63db0bb0e 100644 --- a/Android.mk +++ b/Android.mk @@ -372,7 +372,7 @@ web_docs_sample_code_flags := \ ## SDK version identifiers used in the published docs # major[.minor] version for current SDK. (full releases only) -framework_docs_SDK_VERSION:=1.6 +framework_docs_SDK_VERSION:=2.0 # release version (ie "Release x") (full releases only) framework_docs_SDK_REL_ID:=1 # name of current SDK directory (full releases only) diff --git a/docs/html/guide/developing/updating-sdk.jd b/docs/html/guide/developing/updating-sdk.jd deleted file mode 100644 index f65eabba050da..0000000000000 --- a/docs/html/guide/developing/updating-sdk.jd +++ /dev/null @@ -1,108 +0,0 @@ -page.title=Updating Your SDK -@jd:body - - -
-
-

Quickview

- - -

In this document

-
    -
  1. Installing SDK Packages
  2. -
  3. Adding SDK Package Sites
  4. -
-
-
- -

The Android SDK and AVD Manager lets you -update your Android SDK without a visit to the -Android Developers web site. Instead of downloading an entirely new SDK -that includes Android platforms, tools, and documentation, you can instead -install only the individual packages that you want.

- -

For example, when a new version of the Android platform is made available -for developing applications, use the SDK and AVD Manager to install the -platform into your existing SDK directory. You can then use the new platform -in your AVDs and -build your apps against it.

- -

The benefit to using this feature is that your SDK directory will -remain the same. You don't need to reset the SDK location in -your Eclipse preferences or modify your {@code PATH} environment variable, -because all new packages are installed into your existing SDK directory.

- - -

The SDK and AVD Manager can be opened in two ways:

- - -

The screenshot below shows the Android SDK and AVD Manager -with the Available Packages open.

- - - - -

Installing SDK Packages

- -

When a new Android SDK platform, add-on, set of development tools or -documentation becomes available, you can quickly download and -install them into your existing Android SDK:

- -
    -
  1. Select Available Packages in the left panel. - This will reveal all packages currently available for download.
  2. -
  3. Select the packages you'd like to install and click Install - Selected.
  4. -
  5. Verify and accept the packages you want and click Install - Accepted. The packages will now be installed into your existing - Android SDK directories.
  6. -
- -

New platforms are automatically saved into the -<sdk_dir>/platforms/ directory of your SDK; -new add-ons are saved in the <sdk_dir>/add-ons/ -directory; and new documentation is saved in the existing -<sdk_dir>/docs/ directory (old docs are replaced).

- -

Tip: -Use the "Display updates only" checkbox to show only the packages -you do not have.

- - -

Adding SDK Package Sites

- -

By default, Available Packages only shows -the Google repository for Android SDK packages and Google API -add-ons. You can add additional sites that host -Android SDK add-ons, then download add-on packages from them.

- -

For example, a mobile carrier or hardware manufacturer may offer additional -API libraries that are supported by their own Android-powered devices. -In order for you to develop using their libraries, you may need to install an -Android SDK add-on. -If the carrier or manufacturer has hosted an add-on repository file on their -web site, add their site to the SDK and AVD Manager:

-
    -
  1. Select Available Packages in the left panel.
  2. -
  3. Click Add Site and enter the URL of the -{@code repository.xml} file. Click OK.
  4. -
-

Any SDK packages available from the web site will now be listed and -available for you to install in your existing Android SDK.

- - diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index f6718e1169e5f..264fe549335c7 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -239,7 +239,6 @@
  • Debugging Tasks
  • -
  • Updating Your SDK
  • Tools diff --git a/docs/html/sdk/2.0_r1/installing.jd b/docs/html/sdk/2.0_r1/installing.jd new file mode 100644 index 0000000000000..fd269dc624125 --- /dev/null +++ b/docs/html/sdk/2.0_r1/installing.jd @@ -0,0 +1,389 @@ +page.title=Installing the Android 2.0 SDK +sdk.preview=0 + +@jd:body + + + +

    This page describes how to install the Android SDK and set up your +development environment for the first time.

    + +

    If you encounter any problems during installation, see the +Installation Notes at the bottom of +this page.

    + +

    Updating?

    +

    If you have already installed an earlier version +of the Android SDK, please instead read Updating Your SDK. +

    + + +

    Prepare for Installation

    + +

    Before you begin, take a moment to confirm that your development machine +meets the System Requirements.

    + +

    If you will be developing in Eclipse with the Android Development +Tools (ADT) Plugin — the recommended path if you are new to +Android — make sure that you have a suitable version of Eclipse +installed on your computer (3.4 or newer is recommended). If you need +to install Eclipse, you can download it from this location:

    + +

    http://www.eclipse.org/downloads/

    + +

    A Java or RCP version of Eclipse is recommended.

    + +

    Install the SDK

    + +

    After downloading the Android SDK, unpack the Android SDK .zip archive +to a suitable location on your machine. By default, the SDK files are unpacked +into a directory named android_sdk_<platform>_<release>.

    + +

    Make a note of the name and location of the unpacked SDK directory on your system — you +will need to refer to the SDK directory later, when setting up the Android plugin or when +using the SDK tools.

    + +

    Optionally, you may want to add the location of the SDK's primary tools directory +to your system PATH. The primary tools/ directory is located at the root of the +SDK folder. Adding tools to your path lets you run Android Debug Bridge (adb) and +the other command line tools without +needing to supply the full path to the tools directory.

    + + +

    Note that, if you update your SDK in the future, you +should remember to update your PATH settings to point to the new location, if different.

    + +

    If you will be using the Eclipse IDE as your development environment, +the next section describes how to install the Android Development Tools (ADT) plugin and set up Eclipse. +If you choose not to use Eclipse, you can +develop Android applications in an IDE of your choice and then compile, debug and deploy using +the tools included in the SDK (skip to Next Steps).

    + + +

    Install the ADT Plugin for Eclipse

    + +

    Android offers a custom plugin for the Eclipse IDE, called Android +Development Tools (ADT), that is designed to give you a powerful, +integrated environment in which to build Android applications. It +extends the capabilites of Eclipse to let you quickly set up new Android +projects, create an application UI, add components based on the Android +Framework API, debug your applications using the Android SDK tools, and even export +signed (or unsigned) APKs in order to distribute your application.

    + +

    In general, using Eclipse with ADT is a highly recommended approach to +Android development and is the fastest way to get started. (If you prefer to +work in an IDE other than Eclipse, you do not need to install Eclipse or ADT, +instead, you can directly use the SDK tools to build and debug your +application—skip to Next Steps.)

    + +

    Once you have the Eclipse IDE installed, as described in Preparing for Installation, follow the steps below to +download the ADT plugin and install it in your respective Eclipse environment. +

    + + + + + + + +
    Eclipse 3.4 (Ganymede)Eclipse 3.5 (Galileo)
    + +
      +
    1. Start Eclipse, then select Help > Software Updates.... + In the dialog that appears, click the Available Software tab.
    2. +
    3. Click Add Site...
    4. +
    5. In the Add Site dialog that appears, enter this URL in the "Location" field: +
      https://dl-ssl.google.com/android/eclipse/
      +

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

      +

      Click OK.

    6. +
    7. Back in the Available Software view, you should see the plugin listed by the URL, + with "Developer Tools" nested within it. Select the checkbox next to + Developer Tools and click Install...
    8. +
    9. On the subsequent Install window, "Android DDMS" and "Android Development Tools" + should both be checked. Click Next.
    10. +
    11. Read and accept the license agreement, then click Finish.
    12. +
    13. Restart Eclipse.
    14. +
    + +
    + +
      +
    1. Start Eclipse, then select Help > Install + New Softare.
    2. +
    3. In the Available Software dialog, click Add....
    4. +
    5. In the Add Site dialog that appears, enter a name for the remote site + (e.g., "Android Plugin") in the "Name" field. +

      In the "Location" field, enter this URL:

      +
      https://dl-ssl.google.com/android/eclipse/
      +

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

      +

      Click OK.

      +
    6. +
    7. Back in the Available Software view, you should now see "Developer + Tools" added to the list. Select the checkbox next to Developer Tools, + which will automatically select the nested tools Android DDMS and Android + Development Tools. + Click Next.
    8. +
    9. In the resulting Install Details dialog, the Android DDMS and Android + Development Tools features are listed. Click Next to + read and accept the license agreement and install any dependencies, + then click Finish.
    10. +
    11. Restart Eclipse.
    12. + +
    +
    + +

    Now modify your Eclipse preferences 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. For the SDK Location in the main panel, click Browse... and + locate your downloaded SDK directory.
    6. +
    7. Click Apply, then OK.
    8. +
    + +

    Done! If you haven't encountered any problems, then you're ready to +begin developing Android applications. See the +Next Steps section for suggestions on how to start.

    + + +

    Contents of the SDK

    + +

    Once you've downloaded and unpacked the SDK, open the SDK directory +and take a look at what's inside.

    + +

    The table below describes the SDK directory contents.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescription
    add-ons/Contains add-ons to the Android SDK development +environment, which let you develop against external libraries that are available on some +devices.
    docs/A full set of documentation in HTML format, including the Developer's Guide, +API Reference, and other information.
    platforms/Contains a set of Android platform versions that you can develop +applications against, each in a separate directory.
    <platform>/Platform version directory, for example "Android 1.6". All platform version +directories contain a similar set of files and subdirectory structure.
     data/Storage area for default fonts and resource definitions.
    images/Storage area for default disk images, including the Android system image, +the default userdata image, the default ramdisk image, and more. The images +are used in emulator sessions.
    samples/Contains a wide variety of sample applications that you can load as projects +into your development environment, compile, and run on the emulator.
    skins/A set of emulator skins available for the platform version. Each skin is +designed for a specific screen resolution.
    templates/Storage area for file templates used by the SDK development tools.
    tools/Any development tools that are specific to the platform version.
    android.jarThe Android library used when compiling applications against this platform +version.
    tools/Contains the set of development and profiling tools available to you, such +as the emulator, the android tool, adb, ddms, and more.
    RELEASE_NOTES.htmlA file that loads the local version of the SDK release notes, if +available.
    documentation.htmlA file that loads the entry page for the local Android SDK +documentation.
    + +

    Installation Notes

    + +

    Ubuntu Linux Notes

    + + + +

    Other Linux Notes

    + + + + +

    Troubleshooting ADT Installation

    + +

    If you are having trouble downloading the ADT plugin after following the +steps above, here are some suggestions:

    + + + +

    If you are still unable to use Eclipse to download the ADT plugin as a +remote update site, you can download the ADT zip file to your local machine and +manually install it:

    + +
      +
    1. Download the + ADT Plugin zip file (do not unpack it).
    2. +
    3. Follow steps 1 and 2 in the default install + instructions (above).
    4. +
    5. In the Add Site dialog, click Archive.
    6. +
    7. Browse and select the downloaded zip file.
    8. +
    9. In Eclipse 3.5 only, enter a name for the local update site (e.g., + "Android Plugin") in the "Name" field.
    10. +
    11. Click OK. +
    12. Follow the remaining procedures as listed for + default installation above, + starting from step 4.
    13. +
    + +

    To update your plugin once you've installed using the zip file, you will have +to follow these steps again instead of the default update instructions.

    + +

    Other install errors

    + +

    Note that there are features of ADT that require some optional +Eclipse components (for example, WST). If you encounter an error when +installing ADT, your Eclipse installion might not include these components. +For information about how to quickly add the necessary components to your +Eclipse installation, see the troubleshooting topic +ADT +Installation Error: "requires plug-in org.eclipse.wst.sse.ui".

    + +

    For Linux users

    +

    If you encounter this error when installing the ADT Plugin for Eclipse: +

    +An error occurred during provisioning.
    +Cannot connect to keystore.
    +JKS
    +

    +...then your development machine lacks a suitable Java VM. Installing Sun +Java 6 will resolve this issue and you can then reinstall the ADT +Plugin.

    + + diff --git a/docs/html/sdk/download.jd b/docs/html/sdk/download.jd index 1712ae6212870..76f1213691330 100644 --- a/docs/html/sdk/download.jd +++ b/docs/html/sdk/download.jd @@ -57,15 +57,11 @@ The License Agreement constitutes a contract between you and Google with respect