From 081127be8b8a76a71d5ce3d95db0d84c7a05ed63 Mon Sep 17 00:00:00 2001 From: Scott Main Date: Fri, 29 Oct 2010 15:56:27 -0700 Subject: [PATCH] docs: some more edits to the sdk install docs Change-Id: I1a108ad746a2f2ddf6e8ea3979ef3fb3d5998de3 --- docs/html/sdk/eclipse-adt.jd | 112 +++++++++++++++++------------------ docs/html/sdk/installing.jd | 96 +++++++++++++----------------- 2 files changed, 98 insertions(+), 110 deletions(-) diff --git a/docs/html/sdk/eclipse-adt.jd b/docs/html/sdk/eclipse-adt.jd index 9f3c8b03b4c9c..ef7d865840c69 100644 --- a/docs/html/sdk/eclipse-adt.jd +++ b/docs/html/sdk/eclipse-adt.jd @@ -28,7 +28,7 @@ adt.zip.checksum=7deff0c9b25940a74cea7a0815a3bc36 -

Android Development Tools (ADT) is a plugin for the Eclipse IDE +

Android Development Tools (ADT) is a plugin for the Eclipse IDE that is designed to give you a powerful, integrated environment in which to build Android applications.

@@ -48,7 +48,7 @@ before you can install or use ADT, you must have compatible versions of both the Eclipse IDE and the Android SDK installed. For details, make sure to read Installing the ADT Plugin, below.

-

If you are already using ADT, this document also provides instructions on +

If you are already using ADT, this document also provides instructions on how to update ADT to the latest version or how to uninstall it, if necessary.

@@ -156,7 +156,7 @@ contextual menu. The Action does a full application package refactoring. called src/. There is now support for any number of source folders, with no name restriction. They can even be in subfolder such as src/java. If you are already working with library projects created -in ADT 0.9.7, see Migrating library projects to ADT 0.9.8 for important information about moving to the new ADT environment. @@ -166,7 +166,7 @@ projects. car/desk, night/notnight and navexposed/navhidden.
  • Adds more device screen types in the layout editor. All screen -resolution/density combinations listed in the Supporting Multiple Screens are now available.
  • Fixes problems with handling of library project names that @@ -195,10 +195,10 @@ code and resources in a separate development project. You can then reference the library project from other Android projects and, at build time, the tools compile the shared code and resources as part of the dependent applications. More information about this feature is available in the Developing +href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing in Eclipse with ADT document.

    -

    If you are not developing in Eclipse, SDK Tools r6 provides the equivalent library +

    If you are not developing in Eclipse, SDK Tools r6 provides the equivalent library project support through the Ant build system.

    @@ -215,7 +215,7 @@ ADT 0.9.6 (March 2010)
    Dependencies:
    -

    ADT 0.9.6 is designed for use with SDK Tools r5 and later. Before +

    ADT 0.9.6 is designed for use with SDK Tools r5 and later. Before updating to ADT 0.9.6, we highly recommend that you use the Android SDK and AVD Manager to install SDK Tools r5 into your SDK.

    @@ -339,7 +339,7 @@ bigger than the screen.
    • @@ -347,7 +347,7 @@ Tool) is installed, it'll open the file.
    Android SDK and AVD Manager integration:
    @@ -408,16 +408,16 @@ environment.

      -
    1. Start Eclipse, then select Help > Software Updates.... +
    2. Start Eclipse, then select Help > Software Updates.... In the dialog that appears, click the Available Software tab.
    3. Click Add Site...
    4. 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 acquiring the plugin, try using "http" in the Location URL, - instead of "https" (https is preferred for security reasons).

      + instead of "https" (https is preferred for security reasons).

      Click OK.

    5. 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 + with "Developer Tools" nested within it. Select the checkbox next to Developer Tools and click Install...
    6. On the subsequent Install window, "Android DDMS" and "Android Development Tools" should both be checked. Click Next.
      7. @@ -433,25 +433,25 @@ environment.

      New Software.
    7. In the Available Software dialog, click Add....
    8. In the Add Site dialog that appears, enter a name for the remote site - (for example, "Android Plugin") in the "Name" field. + (for example, "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 acquiring the plugin, you can try - using "http" in the URL, instead of "https" (https is preferred for + using "http" in the URL, instead of "https" (https is preferred for security reasons).

      Click OK.

    9. 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. + 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.
      10. -
    10. 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, +
    11. 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.
    12. Restart Eclipse.
      13. - +
    @@ -466,15 +466,15 @@ is to modify your ADT preferences in Eclipse to point to the Android SDK directo
  • Select Window > Preferences... to open the Preferences panel (Mac OS X: Eclipse > Preferences).
  • Select Android from the left panel.
    • -
  • For the SDK Location in the main panel, click Browse... and +
  • For the SDK Location in the main panel, click Browse... and locate your downloaded SDK directory.
  • Click Apply, then OK.

    • Done! If you haven't encountered any problems, then the installation is -complete. Now read Adding Platforms and -Other Components for instructions on how to complete the setup of your -SDK environment.

    +complete. If you're installing the Android SDK for the first time, return to Installing the SDK to complete your setup. +

    Troubleshooting ADT Installation

    @@ -486,7 +486,7 @@ steps above, here are some suggestions:

  • If Eclipse can not find the remote update site containing the ADT plugin, try changing the remote site URL to use http, rather than https. That is, set the Location for the remote site to: -
    http://dl-ssl.google.com/android/eclipse/
    • +
    http://dl-ssl.google.com/android/eclipse/
  • If you are behind a firewall (such as a corporate firewall), make sure that you have properly configured your proxy settings in Eclipse. In Eclipse 3.3/3.4, you can configure proxy information from the main Eclipse menu in @@ -521,14 +521,14 @@ manually install it:

    • -
  • Follow steps 1 and 2 in the default install +
  • Follow steps 1 and 2 in the default install instructions (above).
  • In the Add Site dialog, click Archive.
  • Browse and select the downloaded zip file.
  • In Eclipse 3.5 only, enter a name for the local update site (e.g., "Android Plugin") in the "Name" field.
  • Click OK. -
  • Follow the remaining procedures as listed for +
  • Follow the remaining procedures as listed for default installation above, starting from step 4.
    • @@ -538,16 +538,16 @@ 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 +

    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: +

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

     An error occurred during provisioning.
 Cannot connect to keystore.
@@ -572,12 +572,12 @@ described in Adding SDK Components.
    
 
 
    To learn about new features of each ADT revision and also any dependencies on
 the SDK Tools, see the listings in the Revisions
-section. To determine the version currently installed, open the 
+section. To determine the version currently installed, open the
 Eclipse Installed Software window using Help
-> Software Updates and refer to the version listed for 
+> Software Updates and refer to the version listed for
 "Android Development Tools".
    
 
-
    Follow the steps below to check whether an update is available and, if so, 
+
    Follow the steps below to check whether an update is available and, if so,
 to install it. 
    
 
 
@@ -588,13 +588,13 @@ to install it. 
      
     
    1. Select Help > Software Updates.
      2. 
     
    2. Select the Available Software tab.
      3. 
-    
    3. Select the checkboxes next to Android DDMS and Android Developer Tools, 
+    
    4. Select the checkboxes next to Android DDMS and Android Developer Tools,
       then click  Update.
      5. 
-    
    5. In the resulting Available Updates dialog, ensure that both Android DDMS 
-      and Android Development Tools are selected, then click 
+    
    6. In the resulting Available Updates dialog, ensure that both Android DDMS
+      and Android Development Tools are selected, then click
       Next.
      7. 
     
    7. Read and accept the license agreement and then click Finish.
-      This will download and install the latest version of Android DDMS and 
+      This will download and install the latest version of Android DDMS and
       Android Development Tools.
      8. 
     
    8. Restart Eclipse.
      9. 
 
    
@@ -603,17 +603,17 @@ to install it. 
      
     
    1. Select Help > Check for Updates. 
      2. 
-    
    2. In the resulting Available Updates dialog, locate the Android DDMS and 
+    
    3. In the resulting Available Updates dialog, locate the Android DDMS and
         Android Development Tools features in the list and ensure that the checkboxes
-        next to them are selected. Click Next. 
-        
      If the Available Updates dialog does not list Android DDMS and Android 
-           Development tools, make sure that you have set up a remote update site 
-           for them, as described in 
-           Installing the ADT Plugin. 
+        next to them are selected. Click Next.
+        
      If the Available Updates dialog does not list Android DDMS and Android
+           Development tools, make sure that you have set up a remote update site
+           for them, as described in
+           Installing the ADT Plugin.
         
      4. 
     
    4. In the Update Details dialog, click Next.
      5. 
     
    5. Read and accept the license agreement and then click Finish.
-      This will download and install the latest version of Android DDMS and 
+      This will download and install the latest version of Android DDMS and
       Android Development Tools.
      6. 
     
    6. Restart Eclipse.
      7. 
 
    
@@ -622,17 +622,17 @@ to install it. 
    
 
 
 
 
    
 
 
-
    If you encounter problems during the update of ADT, you 
+
    If you encounter problems during the update of ADT, you
 can try removing the existing ADT plugin and then performing a fresh
 installation. To remove the plugin, follow the instructions in Uninstalling the ADT Plugin, below. To reinstall 
+href="#uninstalling">Uninstalling the ADT Plugin, below. To reinstall
 the plugin, follow the instructions in Installing the ADT Plugin, above.
    
 
 
 
    Uninstalling the ADT plugin
    
 
-
    If you encounter problems when installing or updating ADT, you 
+
    If you encounter problems when installing or updating ADT, you
 can try removing the existing ADT plugin and then performing a fresh
 installation. To remove ADT, follow these steps: 
    
 
@@ -642,12 +642,12 @@ installation. To remove ADT, follow these steps: 
    
 
 
 
      
-    
    1. Select Help > Software Updates > 
+    
    2. Select Help > Software Updates >
       Manage Configuration. 
      3. 
     
    3. Expand the list in the left panel to reveal the installed tools.
      4. 
-    
    4. Right-click "Android Editors" and click Uninstall. Click OK 
+    
    5. Right-click "Android Editors" and click Uninstall. Click OK
     to confirm.
      6. 
-    
    6. Restart Eclipse. 
+    
    7. Restart Eclipse.
       
      (Do not uninstall "Android Development Tools".)
      8. 
 
    
 
diff --git a/docs/html/sdk/installing.jd b/docs/html/sdk/installing.jd
index 8484beadcba69..c3b103f938b38 100644
--- a/docs/html/sdk/installing.jd
+++ b/docs/html/sdk/installing.jd
@@ -8,10 +8,10 @@ sdk.preview=0
 
   
    In this document
    
   
      
-    
    1. Preparing Your Development Computer
      2. 
-    
    2. Downloading the SDK Starter Package
      3. 
-    
    3. Installing the ADT Plugin for Eclipse
      4. 
-    
    4. Adding Platforms and Other Components
+    
    5. 1. Preparing Your Development Computer
      6. 
+    
    6. 2. Downloading the SDK Starter Package
      7. 
+    
    7. 3. Installing the ADT Plugin for Eclipse
      8. 
+    
    8. 4. Adding Platforms and Other Components
     
        
     
      1. Which components do I need?
        2. 
     
      9. 
@@ -38,65 +38,58 @@ this page.
      
 
 
      Updating?
      
 
-
      If you are currently using the Android 1.6 SDK or later and want to update
-to the latest tools or platforms, you do not need to install a new SDK. Instead,
-you can simply update the individual components in your SDK using the
-Android SDK and AVD Manager tool. For information about how to do that, see Updating SDK
-Components
      
-
-
      If you are using Android 1.5 SDK or earlier, you should install a new SDK as
-described in this document and move your application projects to the new
-SDK environment. 
      
+
      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
      
 
 
 
      Step 1. Preparing Your Development Computer
      
 
 
      Before getting started with the Android SDK, take a moment to confirm that
 your development computer meets the System
-Requirements. In particular, you may need to install the JDK before
-continuing, if it's not already installed on your computer. 
      
+Requirements. In particular, you might need to install the JDK, if you don't have it already. 
      
 
 
      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
+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. For Eclipse 3.5, the
-"Eclipse Classic" version is recommended.
      
+
      For Eclipse 3.5 or newer, the "Eclipse Classic" version is recommended. Otherwise, a Java or
+RCP version of Eclipse is recommended.
      
 
 
 
      Step 2. Downloading the SDK Starter Package
      
 
 
      The first step in setting up your environment for developing Android applications
-is downloading the Android SDK starter package. The starter package is not a full
-development environment — it includes only the core SDK Tools, which you can
-use to download the rest of the SDK components (such as the platform system images). 
      
+is downloading the Android SDK starter package.
      
 
-
      You can get the latest version of the SDK starter package from the SDK download page. Make sure to download the
-package that is appropriate for your development computer.
      
+
      The starter package is not a full
+development environment—it includes only the core SDK Tools, which you can
+use to download the rest of the SDK components (such as the platform system images). 
      
 
 
      Note: If you're using Windows, we recommend that you download
 the SDK installer (the {@code .exe} file from the download table). It will guide you through the
 installation process and check your computer for the required software.
      
 
-
      If you downloaded a {@code .zip} of {@code .tgz} (instead of using the SDK installer), unpack the
-Android SDK archive to a safe location on your machine. By default, the SDK files are unpacked into
-a directory named android-sdk-<machine-platform>.
      
+
      You can get the latest version of the SDK starter package from the SDK download page.
      
+
+
      If you downloaded a {@code .zip} or {@code .tgz} package (instead of the SDK installer), unpack
+it to a safe location on your machine. By default, the SDK files are unpacked
+into a directory named android-sdk-<machine-platform>.
      
 
 
      Make a note of the name and
-location of the unpacked SDK directory on your system — you will need to
+location of the unpacked 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.
      
 
-
      Optionally, you might want to add the location of the SDK's primary
-tools directory and the additional {@code platform-tools/} directory  to your system
+
      Optionally, you might want to add the location of the SDK's
+tools/ directory and {@code platform-tools/} directory  to your system
 PATH. Both tool directories are located at the root of the SDK folder. Adding
 tools/ and {@code platform-tools/} to your path lets you run Android Debug Bridge (adb)
 and the other command line 
   tools/ and {@code platform-tools/} directories to the path. 
   
 
-
      If you will be using the Eclipse IDE as your development environment, the
+
      If you will be using the Eclipse IDE, 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
@@ -135,17 +128,16 @@ and Other Components).
      
 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
+UI, debug your applications
 using the Android SDK tools, and even export signed (or unsigned) APKs in order
 to distribute your application. In general, developing in Eclipse with ADT is a
 highly recommended approach and is the fastest way to get started with Android.
 
      
 
 
      If you'd like to use ADT for developing Android applications, install it now.
-Read ADT Plugin for Eclipse for
-step-by-step installation instructions, then return here to continue with the
-last step in setting up your SDK: adding platforms and other
-components.
      
+Read Installing the ADT Plugin for
+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 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
@@ -157,28 +149,24 @@ debug your application.
      
 
      
 
       
      Using the Android SDK and AVD Manager
      
 
-
      The Android SDK and AVD Manager is a tool that you will use often,
-to add components to your SDK environment and manage Android Virtual Devices.
+
      The Android SDK and AVD Manager is a tool that you will use often
+to add components to your SDK environment and manage Android Virtual Devices.
 
      
 
-
      The tool is pre-installed in your SDK. See See Adding SDK Components for details on how to
 launch and use the tool.
      
 
      
 
      
 
-
      The last step in setting up your SDK is using a tool included the SDK starter
-package — the Android SDK and AVD Manager — to download
-essential components into your development environment. Read the information
-below to understand what components you'll need, then see Adding SDK Components for step-by-step
-instructions on how to launch the Android SDK and AVD Manager and download the
-components into your 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 the API
-documentation — into a set of separately installable components. The SDK
-starter package, which you've already downloaded, includes only a single
+
      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 any Android
 application, you also need to download at least one Android platform into your
 environment, although downloading additional components is highly recommended.
@@ -353,7 +341,7 @@ installed. 
      
 Contains add-ons to the Android SDK development
 environment, which let you develop against external libraries that are available on some
 devices. 
-
+repo
 
 docs/
 A full set of documentation in HTML format, including the Developer's Guide,