diff options
author | Android (Google) Code Review <android-gerrit@google.com> | 2009-08-05 22:08:14 -0700 |
---|---|---|
committer | Android Git Automerger <android-git-automerger@android.com> | 2009-08-05 22:08:14 -0700 |
commit | c0894854947b48675570023507836cb7de4b68d1 (patch) | |
tree | bd64cc499e511c8622ae5dd736b25a82e5b26b24 /docs | |
parent | 9488437b4f55c425b0168d612d729427b19b85ad (diff) | |
parent | be9d08d04ee313d56578934b4f062f95170140fc (diff) | |
download | frameworks_base-c0894854947b48675570023507836cb7de4b68d1.zip frameworks_base-c0894854947b48675570023507836cb7de4b68d1.tar.gz frameworks_base-c0894854947b48675570023507836cb7de4b68d1.tar.bz2 |
am be9d08d0: Merge change 20228 into donut
Merge commit 'be9d08d04ee313d56578934b4f062f95170140fc'
* commit 'be9d08d04ee313d56578934b4f062f95170140fc':
add installing/upgrading docs for donut preview sdk
Diffstat (limited to 'docs')
-rw-r--r-- | docs/html/guide/developing/eclipse-adt.jd | 50 | ||||
-rw-r--r-- | docs/html/sdk/preview/features.jd | 6 | ||||
-rw-r--r-- | docs/html/sdk/preview/installing.jd | 352 | ||||
-rw-r--r-- | docs/html/sdk/preview/requirements.jd | 43 | ||||
-rw-r--r-- | docs/html/sdk/preview/upgrading.jd | 257 |
5 files changed, 670 insertions, 38 deletions
diff --git a/docs/html/guide/developing/eclipse-adt.jd b/docs/html/guide/developing/eclipse-adt.jd index 3b3bb38..a5cf735 100644 --- a/docs/html/guide/developing/eclipse-adt.jd +++ b/docs/html/guide/developing/eclipse-adt.jd @@ -135,7 +135,7 @@ folders and files in your new project:</p> <h2 id="Running">Running Your Application</h2> -<p><em>Wait!</em> Before you can run your application on the Android Emulator, +<p>Before you can run your application on the Android Emulator, you <strong>must</strong> create an Android Virtual Device (AVD). An AVD is a configuration that specifies the Android platform to be used on the emulator. You can read more in the <a href="{@docRoot}guide/developing/tools/avd.html">Android Virtual @@ -149,45 +149,31 @@ on running your applicaiton.</p> <h3 id="CreatingAnAvd">Creating an AVD</h3> -<p>To avoid some explanation that's beyond the scope of this document, here's the -basic procedure to create an AVD:</p> +<p>With ADT 0.9.2 and above, the Android AVD Manager provides a simple graphical interface +for creating and managing AVDs. (If you're using ADT version 0.9.1 or older, you must +use the <code>android</code> tool to create your AVDs—read the AVD guide to +<a href="{@docRoot}guide/developing/tools/avd.html#creating">Creating an AVD</a>.) + +<p>To create an AVD with the Android AVD Manager:</p> <ol> - <li>Open a command-line (e.g.,"Command Prompt" application on Windows, or "Terminal" - on Mac/Linux) and navigate to your SDK package's - <code>tools/</code> directory.</li> - <li>First, you need to select a Deployment Target. To view available targets, execute: - <pre>android list targets</pre> - <p>This will output a list of available Android targets, such as:</p> -<pre> -id:1 - Name: Android 1.1 - Type: platform - API level: 2 - Skins: HVGA (default), HVGA-L, HVGA-P, QVGA-L, QVGA-P -id:2 - Name: Android 1.5 - Type: platform - API level: 3 - Skins: HVGA (default), HVGA-L, HVGA-P, QVGA-L, QVGA-P -</pre> - <p>Find the target that matches the Android platform upon which you'd like - to run your application. Note the integer value of the <code>id</code> — - you'll use this in the next step.</p> + <li>Select <strong>Window > Android AVD Manager</strong>, or click the Android AVD Manager icon (a black device) + in the Eclipse toolbar.</p> </li> - <li>Create a new AVD using your selected Deployment Target. Execute: - <pre>android create avd --name <em><your_avd_name></em> --target <em><targetID></em></pre> - <li>Next, you'll be asked whether you'd like to create a custom hardware profile. - If you respond "yes," you'll be presented with a series of prompts to define various aspects of the - device hardware (leave entries blank to use default values, which are shown in brackets). Otherwise, - press return to use all default values ("no" is the default).</li> + <li>In the Virtual Devices panel, you'll see a list of existing AVDs. Click <strong>New</strong> + to create a new AVD.</li> + <li>Fill in the details for the AVD. + <p>Give it a name, a platform target, an SD card image (optional), and + a skin (HVGA is default).</p> </li> + <li>Click <strong>Create AVD</strong>.</li> </ol> -<p>That's it; your AVD is ready. In the next section, you'll see how the AVD is used +<p>Your AVD is now ready and you can close the Android AVD Manager. +In the next section, you'll see how the AVD is used when launching your application on an emulator.</p> -<p>To learn more about creating and managing AVDs, please read the +<p>For more information about AVDs, read the <a href="{@docRoot}guide/developing/tools/avd.html">Android Virtual Devices</a> documentation.</p> diff --git a/docs/html/sdk/preview/features.jd b/docs/html/sdk/preview/features.jd deleted file mode 100644 index 43856de..0000000 --- a/docs/html/sdk/preview/features.jd +++ /dev/null @@ -1,6 +0,0 @@ -sdk.redirect=true -sdk.redirect.path=android-1.5-highlights.html - -@jd:body - - diff --git a/docs/html/sdk/preview/installing.jd b/docs/html/sdk/preview/installing.jd new file mode 100644 index 0000000..29c70f6 --- /dev/null +++ b/docs/html/sdk/preview/installing.jd @@ -0,0 +1,352 @@ +page.title=Installing the Android SDK +sdk.version=1.6 Early Look +sdk.date=August 2009 + +@jd:body + + +<div id="qv-wrapper"> +<div id="qv"> + + <h2>In this document</h2> + <ol> + <li><a href="#Preparing">Preparing for Installation</a></li> + <li><a href="#Installing">Installing the SDK</a></li> + <li><a href="#InstallingADT">Installing the ADT Plugin for Eclipse</a> + <ol> + <li><a href="#Troubleshooting">Troubleshooting ADT Installation</a></li> + </ol> + </li> + <li><a href="#NextSteps">Next Steps</a></li> + <li><a href="#InstallationNotes">Installation Notes</a></li> + </ol> + +<!-- + <h2>Migrating references</h2> + <ol> + <li><a href="{@docRoot}sdk/api_diff/donut/changes.html">Android 1.6 Early Look API Differences</a></li> + </ol> + --> + +</div> +</div> + +<p>This page describes how to install the Android Early Look SDK and set up your +development environment.</p> + +<p>If you encounter any problems during installation, see the +<a href="#installnotes">Installation Notes</a> at the bottom of +this page.</p> + +<h4 style="margin-top">Upgrading?</h4> +<p>If you have already developed applications using an earlier version +of the Android SDK, please read <a href="upgrading.html">Upgrading the SDK</a>, instead. +</p> + + +<h2 id="Preparing">Preparing for Installation</h2> + +<p>Before you begin, take a moment to confirm that your development machine meets the +<a href="requirements.html">System Requirements</a>. +</p> + +<p>If you will be developing on 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: </p> + +<p style="margin-left:2em;"><a href= +"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a +></p> + +<p>A Java or RCP version of Eclipse is recommended. </p> + +<h2 id="Installing">Installing the SDK</h2> + +<p>Unpack the Android SDK .zip archive to a suitable location on your machine. +By default, the SDK files are unpacked into a directory named +<code>android_sdk_<em><platform</em>>_<em><release></em></code>. +The directory contains a local copy of the documentation (accessible by opening +<code>documentation.html</code> in your browser) and the subdirectories +<code>tools/</code>, <code>add-ons/</code>, <code>platforms/</code>, and others. Inside +each subdirectory of <code>platforms/</code> you'll find <code>samples/</code>, which includes +code samples that are specific to each version of the platform.</p> + +<p>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.</p> + +<p>Optionally, you may want to add the location of the SDK's primary <code>tools</code> directory +to your system <code>PATH</code>. The primary <code>tools/</code> directory is located at the root of the +SDK folder. Adding <code>tools</code> to your path lets you run Android Debug Bridge (adb) and +the other command line <a href="{@docRoot}guide/developing/tools/index.html">tools</a> without +needing to supply the full path to the tools directory. </p> +<ul> + <li>On Linux, edit your <code>~/.bash_profile</code> or <code>~/.bashrc</code> file. Look + for a line that sets the PATH environment variable and add the + full path to the <code>tools/</code> directory to it. If you don't + see a line setting the path, you can add one:</li> + + <ul><code>export PATH=${PATH}:<em><your_sdk_dir></em>/tools</code></ul> + + <li>On a Mac, look in your home directory for <code>.bash_profile</code> and + proceed as for Linux. You can create the <code>.bash_profile</code> if + you haven't already set one up on your machine. </li> + + <li>On Windows, right-click on My Computer, and select Properties. + Under the Advanced tab, hit the Environment Variables button, and in the + dialog that comes up, double-click on Path (under System Variables). Add the full path to the + <code>tools/</code> directory to the path. </li> + </ul> + +<p>Note that, if you update your SDK in the future, you +should remember to update your <code>PATH</code> settings to point to the new location, if different.</p> + +<p>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 <a href="#next">Next Steps</a>).</p> + + +<h2 id="InstallingADT">Installing the ADT Plugin for Eclipse</h2> + +<p>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.</p> + +<p>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 <a href="#NextSteps">Next Steps</a>.)</p> + +<p>Once you have Eclipse installed, as described in <a href="#setup">Preparing for +Installation</a>, follow the steps below to +download the ADT plugin and install it in your respective Eclipse +environment. </p> + +<table style="font-size:100%"> +<tr><th>Eclipse 3.3 (Europa)</th><th>Eclipse 3.4 (Ganymede)</th></tr> +<tr> +<td width="45%"> +<!-- 3.3 steps --> +<ol> + <li>Start Eclipse, then select <strong>Help</strong> > <strong>Software Updates</strong> +> <strong>Find and Install...</strong>. </li> + <li>In the dialog that appears, select <strong>Search for new features to install</strong> +and click <strong>Next</strong>. </li> + <li>Click <strong>New Remote Site</strong>. </li> + <li>In the resulting dialog box, enter a name for the remote site (e.g. "Android Plugin") and + enter the URL: + <pre>https://dl-ssl.google.com/android/eclipse/</pre> + <p>If you have trouble aqcuiring the plugin, try using "http" in the URL, + instead of "https" (https is preferred for security reasons).</p> + <p>Click <strong>OK</strong>.</p> </li> + <li>You should now see the new site added to the search list (and checked). + Click <strong>Finish</strong>. </li> + <li>In the subsequent Search Results dialog box, select the checkbox for the + "Android Plugin". + This will select the nested tools: "Android DDMS" and "Android Development Tools". + Click <strong>Next</strong>.</li> + <li>Read and accept the license agreement, then click <strong>Next</strong>. </li> + <li>On the following Installation window, click <strong>Finish</strong>. </li> + <li>The ADT plugin is not digitally signed. Accept the installation anyway + by clicking <strong>Install All</strong>. </li> + <li>Restart Eclipse. </li> +</ol> + +</td> +<td> + +<!-- 3.4 steps --> +<ol> + <li>Start Eclipse, then select <strong>Help</strong> > <strong>Software Updates...</strong>.</li> + <li>In the dialog that appears, click the <strong>Available Software</strong> tab. </li> + <li>Click <strong>Add Site...</strong> </li> + <li>Enter the Location: + <pre>https://dl-ssl.google.com/android/eclipse/</pre> + <p>If you have trouble aqcuiring the plugin, try using "http" in the Location URL, + instead of "https" (https is preferred for security reasons).</p> + <p>Click <strong>OK</strong>.</p></li> + <li>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 <strong>Install...</strong></li> + <li>On the subsequent Install window, "Android DDMS" and "Android Development Tools" + should both be checked. Click <strong>Next</strong>. </li> + <li>Read and accept the license agreement, then click <strong>Finish</strong>.</li> + <li>Restart Eclipse. </li> +</ol> + +</td> +</tr> +</table> + +<p>Now modify your Eclipse preferences to point to the Android SDK directory:</p> +<ol> + <li>Select <strong>Window</strong> > <strong>Preferences...</strong> to open the Preferences + panel (Mac: <strong>Eclipse</strong> > <strong>Preferences</strong>).</li> + <li>Select <strong>Android</strong> from the left panel. </li> + <li>For the <em>SDK Location</em> in the main panel, click <strong>Browse...</strong> and +locate your downloaded SDK directory. </li> + <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li> +</ol> + +<p>Done! If you haven't encountered any problems, then you're ready to +begin developing Android applications. See the +<a href="#next">Next Steps</a> section for suggestions on how to start. </p> + + +<h3 id="Troubleshooting">Troubleshooting ADT Installation</h3> +<p> +If you are having trouble downloading the ADT plugin after following the steps above, here are +some suggestions: </p> + +<ul> + <li>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: + <pre>http://dl-ssl.google.com/android/eclipse/</pre></li> + <li>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 <strong>Window</strong> (on Mac, <strong>Eclipse</strong>) > + <strong>Preferences</strong> > <strong>General</strong> > + <strong>Network Connections</strong>.</li> +</ul> +<p> +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 the it: +</p> +<ol> + <li><a href="http://developer.android.com/sdk/preview/index.html">Download the ADT Plugin zip file</a> (do not unpack it).</li> + <li>Follow steps 1 and 2 in the default install instructions (above).</li> + <li>In Eclipse 3.3, click <strong>New Archive Site...</strong>. <br/> + In Eclipse 3.4, click <strong>Add Site...</strong>, then <strong>Archive...</strong></li> + <li>Browse and select the downloaded zip file.</li> + <li>Follow the remaining procedures, above, starting from steps 5.</li> +</ol> +<p>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.</p> + +<h4>Other install errors</h4> + +<p>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 +<a href="{@docRoot}guide/appendix/faq/troubleshooting.html#installeclipsecomponents">ADT +Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p> + +<h4>For Linux users</h4> +<p>If you encounter this error when installing the ADT Plugin for Eclipse: +<pre> +An error occurred during provisioning. +Cannot connect to keystore. +JKS</pre> +<p> +...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.</p> + + +<h2 id="NextSteps">Next Steps</h2> +<p>Once you have completed installation, you are ready to +begin developing applications. Here are a few ways you can get started: </p> + +<p><strong>Learn about Android</strong></p> +<ul> + <li>Take a look at the <a href="{@docRoot}guide/index.html">Dev + Guide</a> and the types of information it provides</li> + <li>Read an introduction to Android as a platform in <a + href="{@docRoot}guide/basics/what-is-android.html">What is + Android?</a></li> + <li>Learn about the Android framework and how applications run on it in + <a href="{@docRoot}guide/topics/fundamentals.html">Application + Fundamentals</a></li> + <li>Take a look at the Android framework API specification in the <a + href="{@docRoot}reference/packages.html">Reference</a> tab</li> +</ul> + +<p><strong>Explore the SDK</strong></p> +<ul> + <li>Get an overview of the <a + href="{@docRoot}guide/developing/tools/index.html">development + tools</a> that are available to you</li> + <li>Read how to develop <a + href="{@docRoot}guide/developing/eclipse-adt.html">in Eclipse/ADT</a> or + <a href="{@docRoot}guide/developing/other-ide.html">in other IDEs</a> + </li> +</ul> + +<p><strong>Explore some code</strong></p> +<ul> + <li>Set up a <a href="{@docRoot}guide/tutorials/hello-world.html">Hello + World application</a> (highly recommended, especially for Eclipse users)</li> + <li>Follow the <a href="{@docRoot}guide/tutorials/notepad/index.html"> + Notepad Tutorial</a> to build a full Android application </li> + <li>Create a new project for one of the other sample applications + included in <code><em><sdk></em>/platforms/<em><platfrom></em>/samples</code>, + then compile and run it in your development environment</li> +</ul> + +<p><strong>Visit the Android developer groups</strong></p> +<ul> + <li>Take a look at the <a + href="{@docRoot}community/index.html">Community</a> tab to see a list of + Android developers groups. In particular, you might want to look at the + <a href="http://groups.google.com/group/android-developers">Android + Developers</a> group to get a sense for what the Android developer + community is like.</li> +</ul> + + +<h2 id="InstallationNotes">Installation Notes</h2> + +<h3>Ubuntu Linux Notes</h3> + +<ul> + <li>If you need help installing and configuring Java on your + development machine, you might find these resources helpful: + <ul> + <li><a href="https://help.ubuntu.com/community/Java">https://help.ubuntu.com/community/Java </a></li> + <li><a href="https://help.ubuntu.com/community/Java">https://help.ubuntu.com/community/JavaInstallation</a></li> + </ul> + </li> + <li>Here are the steps to install Java and Eclipse, prior to installing + the Android SDK and ADT Plugin. + <ol> + <li>If you are running a 64-bit distribution on your development + machine, you need to install the <code>ia32-libs</code> package using + <code>apt-get:</code>: + <pre>apt-get install ia32-libs</pre> + </li> + <li>Next, install Java: <pre>apt-get install sun-java6-bin</pre></li> + <li>The Ubuntu package manager does not currently offer an Eclipse 3.3 + version for download, so we recommend that you download Eclipse from + eclipse.org (<a + href="http://www.eclipse.org/downloads/">http://www.eclipse.org/ + downloads/</a>). A Java or RCP version of Eclipse is recommended.</li> + <li>Follow the steps given in previous sections to install the SDK + and the ADT plugin. </li> + </ol> + </li> +</ul> + +<h3>Other Linux Notes</h3> + +<ul> + <li>If JDK is already installed on your development computer, please + take a moment to make sure that it meets the version requirements listed + in the <a href="{@docRoot}sdk/{@sdkCurrent}/requirements.html">System Requirements</a>. + In particular, note that some Linux distributions may include JDK 1.4 or Gnu + Compiler for Java, both of which are not supported for Android development.</li> +</ul> + + + diff --git a/docs/html/sdk/preview/requirements.jd b/docs/html/sdk/preview/requirements.jd new file mode 100644 index 0000000..612d23d --- /dev/null +++ b/docs/html/sdk/preview/requirements.jd @@ -0,0 +1,43 @@ +page.title=System Requirements +@jd:body + +<p>The sections below describe the system and software requirements for developing +Android applications using the Android SDK tools included in Android +<?cs var:sdk.version ?> SDK<?cs if:sdk.rel.id ?>, Release <?cs var:sdk.rel.id ?><?cs /if ?>. </p> + +<h3>Supported Operating Systems</h3> +<ul> + <li>Windows XP (32-bit) or Vista (32- or 64-bit)</li> + <li>Mac OS X 10.4.8 or later (x86 only)</li> + <li>Linux (tested on Linux Ubuntu Dapper Drake)</li> +</ul> + +<h3>Supported Development Environments</h3> +<ul> + <li>Eclipse IDE + <ul> + <li><a href="http://www.eclipse.org/downloads/">Eclipse</a> 3.3 (Europa), 3.4 (Ganymede), 3.5 (Galileo) + <ul> + <li><strong>Note:</strong> Eclipse 3.3 has not been fully tested with ADT 0.9.2 and support can no longer be guaranteed. We suggest you upgrade to + Eclipse 3.4 or 3.5.</li> + <li>Recommended Eclipse IDE packages: Eclipse IDE for Java EE Developers, Eclipse IDE for Java Developers, Eclipse for RCP/Plug-in Developers</li> + <li>Eclipse <a href="http://www.eclipse.org/jdt">JDT</a> plugin (included in most Eclipse IDE packages) </li> + <li>Eclipse Classic IDE package is not supported.</li> + </ul> + </li> + <li><a href="http://java.sun.com/javase/downloads/index.jsp">JDK 5 or JDK 6</a> (JRE alone is not sufficient)</li> + <li><a href="installing.html#installingplugin">Android Development Tools plugin</a> (optional)</li> + <li><strong>Not</strong> compatible with Gnu Compiler for Java (gcj)</li> + </ul> + </li> + <li>Other development environments or IDEs + <ul> + <li><a href="http://java.sun.com/javase/downloads/index.jsp">JDK 5 or JDK 6</a> (JRE alone is not sufficient)</li> + <li><a href="http://ant.apache.org/">Apache Ant</a> 1.6.5 or later for Linux and Mac, 1.7 or later for Windows</li> + <li><strong>Not</strong> compatible with Gnu Compiler for Java (gcj)</li> + </ul> + </li> +</ul> + +<p class="note"><strong>Note:</strong> If JDK is already installed on your development computer, please take a moment to make sure that it meets the version requirements listed above. In +particular, note that some Linux distributions may include JDK 1.4 or Gnu Compiler for Java, both of which are not supported for Android development. </p>
\ No newline at end of file diff --git a/docs/html/sdk/preview/upgrading.jd b/docs/html/sdk/preview/upgrading.jd new file mode 100644 index 0000000..99159fb --- /dev/null +++ b/docs/html/sdk/preview/upgrading.jd @@ -0,0 +1,257 @@ +page.title=Upgrading the SDK +sdk.version=1.6 Early Look +@jd:body + + +<div id="qv-wrapper"> +<div id="qv"> + + <h2>Upgrading the SDK</h2> + <ul> + <li>To move existing projects into the SDK, you must make some minor changes in your + development environment.</li> + <li>ADT 0.9[.1] is not compatible with the Android 1.6 Early Look SDK. You must upgrade + ADT to 0.9.2.</li> + </ul> + + <h2>In this document</h2> + <ol> + <li><a href="#Install">Install the SDK</a></li> + <li><a href="#UpdateAdt">Update Your Eclipse ADT Plugin</a></li> + <li><a href="#RunYourApps">Run Your Applications</a></li> + <li><a href="#ConvertYourApps">Convert Your Applications</a></li> + </ol> + + <h2>Migrating references</h2> + <ol> + <li><a href="{@docRoot}sdk/api_diff/4/changes.html">Android 1.6 Early Look API Differences</a></li> + </ol> + +</div> +</div> + +<p>This document describes how to move your development environment and existing +Android applications from an Android 1.5 SDK to the Android 1.6 Early Look SDK. +If you are migrating applications from an SDK older than 1.5, please also read the upgrading +document available in the Android 1.5 SDK package.</p> + +<p>There are several compelling reasons to upgrade, such as new SDK tools +that make developing more efficient and new APIs that allow you to expand the feature-set +of your applications. However, even if you or your applications don't require these enhancements, +it's important that you upgrade to ensure that your applications run properly on the upcoming +Android platform.</p> + +<p>The Android 1.6 platform will soon be deployable to devices around the world. +If you have already released Android applications to the public, you should +test the forward-compatibility of your applications on the latest version of the platform +as soon as possible. It's unlikely that you'll encounter breakage in your applications, but +in the interest of maintaining the best user experience, you should take no risks. +So, please install the new Android SDK and test your applications on the new platform.</p> + +<!-- NOT AVAILABLE FOR THE PREVIEW +<p>For more information on new SDK features and system changes, +see the <a href="{@docRoot}sdk/android-1.5.html">Android 1.5 Version Notes</a>.</p> +--> + +<h2 id="Install">Install the SDK</h2> + +<!-- +<p>If you haven't yet downloaded the SDK, <a href="index.html">download from here</a> +and unpack it into a safe location.</p> +--> +<p>Now that you have the Android 1.6 Early Look SDK, +you need to perform some of the regular installation steps.</p> + + +<p>If you had previously setup your <code>PATH</code> variable to point to the SDK tools directory, +then you need to update it to point to the new SDK. For example, for a +<code>.bashrc</code> or <code>.bash_profile</code> file:</p> +<pre>export PATH=$PATH:<em><your_sdk_dir></em>/tools</pre> + + +<h2 id="UpdateAdt">Update Your Eclipse ADT Plugin</h2> + +<p>If you don't use Eclipse for development, +skip to <a href="#updateYourProjects">Update Your Projects</a>.</p> + +<!-- +<p><em>If you installed ADT 0.9.2 with the Android 1.6 Early Look SDK, there have been +additional changes, so please continue with this guide and update ADT.</em></p> +--> + +<p>A new ADT plugin (version 0.9.2) is required for the Android 1.6 Early Look SDK. +With ADT 0.9.2, you can still compile your applications against +multiple platform versions, such as Android 1.5. However, previous versions +of ADT will not work with the Android 1.6 Early Look SDK, so you must upgrade +to ADT 0.9.2.</p> + +<p>If you're currently using a version of ADT <em>older</em> than version 0.9, then you must +uninstall ADT before you proceed (read how to +<a href="http://developer.android.com/sdk/1.5_r3/upgrading.html#uninstallAdt">Uninstall +your previous ADT plugin</a>). If you currently have version 0.9 or 0.9.1, then you don't +need to uninstall and can continue with the procedure below.</p> + +<h3 id="installAdt">Install the 0.9.2 ADT plugin</h3> + +<p>To install the new ADT plugin, follow the steps below for your respective version of Eclipse.</p> + +<table style="font-size:100%"> +<tr><th>Eclipse 3.3 (Europa)</th><th>Eclipse 3.4 (Ganymede)</th></tr> +<tr> +<td width="50%"> +<!-- 3.3 steps --> +<ol> + <li>Select <strong>Help</strong> > <strong>Software Updates</strong> > + <strong>Find and Install</strong>. </li> + <li>Select <strong>Search for new features to install</strong>.</li> + <li>Select the Android plugin entry by checking the box next to it, + then click <strong>Finish</strong>. + <p>(Your original entry for the plugin should still be here. If not, see the guide + to <a href="installing.html#installingplugin">Installing the ADT Plugin</a>.) + </p></li> + <li>In the results, expand the entry for the Android plugin and + be sure that "Developer Tools" is checked, then click <strong>Next</strong>. + (This will install "Android DDMS" and "Android Development Tools".)</li> + <li>Read and accept the license agreement, then click <strong>Next</strong>. + <li>In the next window, click <strong>Finish</strong> to start installation.</li> + <li>The ADT plugin is not digitally signed. Accept the installation anyway by clicking + <strong>Install All</strong>.</li> + <li>Restart Eclipse.</li> +</ol> +</td> +<td> +<!-- 3.4 steps --> +<ol> + <li>Select <strong>Help</strong> > <strong>Software Updates</strong>.</li> + <li>Select the <strong>Available Software</strong> tab.</li> + <li>Expand the entry for the Andriod plugin (may be listed as the location URL) + and select "Developer Tools" by checking the box next to it, then click + <strong>Install</strong>.</li> + <li>On the next window, "Android DDMS" and "Android Development Tools" + should both be checked. Click <strong>Finish</strong>.</li> + <li>Restart Eclipse.</li> +</ol> +</td> +</tr> +</table> + +<p>If you encounter problems with this update procedure, try performing a fresh installation. +Ensure your current ADT is fully uninstalled and then +follow the guide to <a href="installing.html#InstallingADT">Installing the ADT Plugin +for Eclipse</a>.</p> + +<h3 id="updateEclipsePrefs">Update your Eclipse SDK Preferences</h3> + +<p>The last step is to update your Eclipse preferences to point to the new SDK directory:</p> +<ol> + <li>Select <strong>Window</strong> > <strong>Preferences</strong> to open the Preferences + panel (Mac: <strong>Eclipse</strong> > <strong>Preferences</strong>).</li> + <li>Select <strong>Android</strong> from the left panel.</li> + <li>For the SDK Location, click <strong>Browse</strong> + and locate your SDK directory.</li> + <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li> +</ol> + + +<h2 id="RunYourApps">Run Your Applications</h2> + +<p>Now that you have installed the Android 1.6 Early Look SDK, we encourage you +to run each of your applications in an instance +of the emulator that's running the new Android 1.6 system image. It's possible (however, unlikely) +that you'll encounter unexpected behavior in your application when you run your applications on +the new system image. Whether you believe your application will be affected by +platform changes or not, it's very important that you test the application's +forward-compatibility.</p> + +<p>To test forward-compatibility, simply run your application, as-is, on an instance of the Android +Emulator that uses an AVD targeted to "Android Donut (Preview)":</p> + +<ol> + <li>Make no changes to your application code.</li> + <li>Create a new AVD that's targeted to the "Donut" platform.</li> + <li>Launch your application in an emulator running the new AVD.</li> + <li>Perform normal testing on your application to ensure everything works as expected.</li> +</ol> + +<p>For more information on creating an AVD and launching your application refer to the +<a href="{@docRoot}guide/developing/eclipse-adt.html#Running">Eclipse guide to +Running Your Application</a> or the +<a href="{@docRoot}guide/developing/other-ide.html#Running">Ant guide to +Running Your Application</a>, depending on your development environment.</p> + + +<h2 id="ConvertYourApps">Convert Your Applications</h2> + +<p>If you want to fully utilize new APIs introduced with the Android 1.6 Early Look SDK, +then you'll need to convert your application to compile against the new "Donut" platform.</p> + +<p>First, you need to change the value of the <code>minSdkVersion</code> attribute in +the <code><uses-sdk></code> manifest element. While +running your application against the Donut platform included with the Early Look SDK, you +<strong>must</strong> set the <code>minSdkVersion</code> value to "Donut". For example:</p> + +<pre> +<manifest> + ... + <uses-sdk android:minSdkVersion="Donut" /> + ... +</manifest> +</pre> + +<p>This value is required only while compiling against the Donut platform included with +the Android 1.6 Early Look SDK. Once the final SDK is made +available for Android 1.6, you will need to change this value. +For more information, read about the <a href="index.html#provisional">Framework API and +Provisional API Level</a>.</p> + +<p>Once you've changed the <code>minSdkVersion</code> value in your application's manifest, +continue with the procedures below to convert your applications.</p> + +<h3 id="EclipseUsers">Eclipse users</h3> + +<ol> + <li>Right-click on the individual project (in the Package Explorer) + and select <strong>Properties</strong>.</li> + <li>In the properties, open the Android panel and select a new Project Build Target. + Select "Android Donut (Preview)" to target the new + platform (or "Google APIs" with the "Donut" platform if your application uses the Maps APIs).</li> + <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li> +</ol> + + <p>Remember that you must create an AVD that targets the same platform in order to run the emulator. + Continue with the + <a href="{@docRoot}guide/developing/eclipse-adt.html#Running">Eclipse guide to + Running Your Application</a>. During the procedure to Running Your Application, select a "deployment + target" or the AVD that includes the "Donut" platform. If your application utilizes the Google Maps APIs (i.e., + MapView), be certain to select a target that includes the Google APIs.</p> + + +<h3 id="AntUsers">Ant users</h3> + + <p>Use the <code>android</code> tool (located in <code><em>your_sdk</em>/tools/</code>) + to create a new <code>build.xml</code> that references + the new platform target. To see a list of available targets, execute:</p> + + <pre>android list targets</pre> + + <p>Select the target <code>id</code> that corresponds to the "Donut" platform and pass it with the + <code>--target</code> parameter when updating your project. For example:</p> + + <pre>android update project --path /path/to/my-project --target 2</pre> + +<p>Remember that you must create an Android Virtual Device (AVD) that's targeted to the + same platform before you can run the updated application an instance + of the emulator. Please continue with the + <a href="{@docRoot}guide/developing/other-ide.html#Running">Ant guide to + Running Your Application</a>. During the procedure to Running Your Application, select a "deployment + target" for the AVD that includes the "Donut" platform. + If your application utilizes the Google Maps APIs (i.e., + MapView), be certain to select a target that includes the Google APIs.</p> + + +<div class="special"> +<p>If you have additional trouble updating your code, visit the +<a href="http://groups.google.com/group/android-developers">Android Developers Group</a> +to seek help from other Android developers.</p> +</div> + |