Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a6602f1f authored by Dirk Dougherty's avatar Dirk Dougherty
Browse files

Add docs for SDK update.

Add redirects for preview files.
Manually integrate a few doc changes from cupcake.

Change-Id:I524d7dbf929371ee501599229894640660f352ce
parent 96b7f921
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
@@ -361,13 +361,13 @@ 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.5
framework_docs_SDK_VERSION:=1.6
  # release version (ie "Release x")  (full releases only)
framework_docs_SDK_REL_ID:=3
framework_docs_SDK_REL_ID:=1
  # name of current SDK directory (full releases only)
framework_docs_SDK_CURRENT_DIR:=$(framework_docs_SDK_VERSION)_r$(framework_docs_SDK_REL_ID)
  # flag to build offline docs for a preview release
framework_docs_SDK_PREVIEW:=true
framework_docs_SDK_PREVIEW:=0

framework_docs_LOCAL_DROIDDOC_OPTIONS += \
		-hdf sdk.version $(framework_docs_SDK_VERSION) \
+8 −14
Original line number Diff line number Diff line
@@ -53,48 +53,42 @@ phrasing your questions, read <a href="http://www.catb.org/%7Eesr/faqs/smart-que
<li><b>Android beginners</b> - You're new to Android application development. You want to figure out how to get started with the Android SDK and the basic Android APIs? Start here. This list is open to any discussion around beginner-type questions for developers using the SDK; this is a great way to get up and running with your new application on the Android platform. Ask about getting your development environment set up, get help with the first steps of Android development (your first User Interface, your first permission, your first file on the Android filesystem, your first app on the Android Market...). Be sure to check the archives first before asking new questions. Please avoid advanced subjects, which belong on android-developers, and user questions, which will get a better reception on android-discuss.
<ul>
<li>Subscribe using Google Groups:&nbsp;<a href="http://groups.google.com/group/android-beginners">android-beginners</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-beginners-subscribe@googlegroups.com">android-beginners-subscribe@googlegroups.com</a><a href="mailto:android-platform-subscribe@googlegroups.com">
</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-beginners-subscribe@googlegroups.com">android-beginners-subscribe@googlegroups.com</a></li>
</ul>
</li>

<li><b>Android developers</b> - You're now an experienced Android application developer. You've grasped the basics of Android app development, you're comfortable using the SDK, now you want to move to advanced topics. Get help here with troubleshooting applications, advice on implementation, and strategies for improving your application's performance and user experience. This is the not the right place to discuss user issues (use android-discuss for that) or beginner questions with the Android SDK (use android-beginners for that).
<ul>
<li>Subscribe using Google Groups:&nbsp;<a href="http://groups.google.com/group/android-developers">android-developers</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-developers-subscribe@googlegroups.com">android-developers-subscribe@googlegroups.com</a><a href="mailto:android-platform-subscribe@googlegroups.com">
</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-developers-subscribe@googlegroups.com">android-developers-subscribe@googlegroups.com</a></li>
</ul>
</li>

<li><b>Android discuss</b> - The "water cooler" of Android discussion. You can discuss just about anything Android-related here, ideas for the Android platform, announcements about your applications, discussions about Android devices, community resources... As long as your discussion is related to Android, it's on-topic here. However, if you have a discussion here that could belong on another list, you are probably not reaching all of your target audience here and may want to consider shifting to a more targeted list.
<ul>
<li>Subscribe using Google Groups:&nbsp;<a href="http://groups.google.com/group/android-discuss">android-discuss</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-discuss-subscribe@googlegroups.com">android-discuss-subscribe@googlegroups.com</a><a href="mailto:android-platform-subscribe@googlegroups.com">
    </a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-discuss-subscribe@googlegroups.com">android-discuss-subscribe@googlegroups.com</a></li>
</ul>
</li>

<li><b>Android ndk</b> - A place for discussing the Android NDK and topics related to using native code in Android applications. 
<ul>
<li>Subscribe using Google Groups:&nbsp;<a href="http://groups.google.com/group/android-ndk">android-ndk</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-ndk-subscribe@googlegroups.com">android-ndk-subscribe@googlegroups.com</a><a href="mailto:android-platform-subscribe@googlegroups.com">
    </a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-ndk-subscribe@googlegroups.com">android-ndk-subscribe@googlegroups.com</a></li>
</ul>
</li>

<li><b>Android security discuss</b> - A place for open discussion on secure development, emerging security concerns, and best practices for and by android developers. Please don't disclose vulnerabilities directly on this list, you'd be putting all Android users at risk.
<ul>
<li>Subscribe using Google Groups:&nbsp;<a href="http://groups.google.com/group/android-security-discuss">android-security-discuss</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-security-discuss@googlegroups.com">android-security-discuss@googlegroups.com</a><a href="mailto:android-platform-subscribe@googlegroups.com">
    </a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-security-discuss@googlegroups.com">android-security-discuss@googlegroups.com</a></li>
</ul>
</li>

<li><b>Android security announce</b> - A low-volume group for security-related announcements by the Android Security Team.
<ul>
<li>Subscribe using Google Groups:&nbsp;<a href="http://groups.google.com/group/android-security-announce">android-security-announce</a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-security-announce-subscribe@googlegroups.com">android-security-announce-subscribe@googlegroups.com</a>
<a href="mailto:android-platform-subscribe@googlegroups.com">    </a></li>
<li>Subscribe via email:&nbsp;<a href="mailto:android-security-announce-subscribe@googlegroups.com">android-security-announce-subscribe@googlegroups.com</a></li>
</ul>
</li>

+307 −65

File changed.

Preview size limit exceeded, changes collapsed.

+11 −5
Original line number Diff line number Diff line
@@ -149,15 +149,15 @@ on running your applicaiton.</p>

<h3 id="CreatingAnAvd">Creating an AVD</h3>

<p>With ADT 0.9.2 and above, the Android AVD Manager provides a simple graphical interface
<p>With ADT 0.9.3 and above, the Android SDK and 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&mdash;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>
<p>To create an AVD with the AVD Manager:</p>

<ol>
  <li>Select <strong>Window > Android AVD Manager</strong>, or click the Android AVD Manager icon (a black device)
  <li>Select <strong>Window > Android SDK and AVD Manager</strong>, or click the Android SDK and AVD Manager icon (a black device)
    in the Eclipse toolbar.</p>
  </li>
  <li>In the Virtual Devices panel, you'll see a list of existing AVDs. Click <strong>New</strong>
@@ -169,7 +169,7 @@ use the <code>android</code> tool to create your AVDs&mdash;read the AVD guide t
  <li>Click <strong>Create AVD</strong>.</li>
</ol>

<p>Your AVD is now ready and you can close the Android AVD Manager. 
<p>Your AVD is now ready and you can close the AVD Manager. 
In the next section, you'll see how the AVD is used
when launching your application on an emulator.</p>

@@ -217,7 +217,7 @@ to start, the emulator options to use, and so on. When you first run a project
as an <em>Android Application</em>, ADT will automatically create a run configuration.
The default run configuration will
launch the default project Activity and use automatic target mode for device selection 
(with no preferred AVD). If the default setting don't suit your project, you can 
(with no preferred AVD). If the default settings don't suit your project, you can 
customize the launch configuration or even create a new.</p>

<p>To create or modify a launch configuration, follow these steps as appropriate 
@@ -256,6 +256,12 @@ for your Eclipse version:</p>
    when selecting an AVD to run your application.
    See the following section on <a href=#AutoAndManualModes">Automatic and manual target 
    modes</a>).</p>
    <p>You can specify any emulator options to the Additional Emulator Command
    Line Options field. For example, you could add <code>-scale 96dpi</code> to
    scale the AVD's screen to an accurate size, based on the dpi of your
    computer monitor. For a full list of emulator options, see the <a
    href="{@docRoot}guide/developing/tools/emulator.html">Android Emulator</a>
document.</p>
  </li>
</ol>

+55 −39
Original line number Diff line number Diff line
@@ -11,6 +11,8 @@ page.title=Android Virtual Devices
        hardware options, system image, and data storage.
    <li>You create AVD configurations to model different device environments 
        in the Android emulator.</li>
    <li>The <code>android</code> tool offers a graphical Android AVD 
        Manager and a command-line interface for creating AVDs.</li>
  </ul>
  <h2>In this document</h2>
  <ol>
@@ -72,9 +74,18 @@ reference of emulator options, please see the <a
href="{@docRoot}guide/developing/tools/emulator.html">Emulator</a>
documentation. </p>

<p>To create and manage AVDs, you use the android tool provided in the Android
SDK. For more information about how to work with AVDs from inside
your development environment, see <a
<p>To create and manage AVDs, you use the <code>android</code> tool provided in
the <code>tools/</code> directory of the Android SDK. The tool provides both a
graphical AVD manager and a command-line interface that you can use to
create AVDs. To access the graphical AVD manager, run the
<code>android</code> tool without options. The sections below describe how to
use the <code>android</code> command-line interface to create and manage AVDs.
Note that some functionality, such as the capability to create an AVD with a
custom hardware configuration, are only available through the command-line
interface. </p>

<p>For more information about how to work with AVDs from inside your development
environment, see <a
href="{@docRoot}guide/developing/eclipse-adt.html">Developing in Eclipse with
ADT</a> or <a href="{@docRoot}guide/developing/other-ide.html">Developing in
Other IDEs</a>, as appropriate for your environment.</p>
@@ -89,11 +100,11 @@ you need to create an AVD before you can run any application in the emulator
</div>
</div>

<p>To create an AVD, you use the android tool, a command-line utility
available in the <code>&lt;sdk&gt;/tools/</code> directory. Managing AVDs is one
of the two main function of the android tool (the other is creating and updating
Android projects). Open a terminal window and change to the 
<code>&lt;sdk&gt;/tools/</code> directory, if needed</p>
<p>To create an AVD, you use the <code>android</code> tool, a command-line
utility available in the <code>&lt;sdk&gt;/tools/</code> directory. Managing
AVDs is one of the two main function of the <code>android</code> tool (the other
is creating and updating Android projects). Open a terminal window and change to
the <code>&lt;sdk&gt;/tools/</code> directory, if needed</p>

<p>To create each AVD, you issue the command <code>android create avd</code>,
with options that specify a name for the new AVD and the system image you want
@@ -118,11 +129,12 @@ version or that of any SDK add-on. Later, when applications use the AVD, they'll
be running on the system that you specify in the <code>-t</code> argument.<p>

<p>To specify the system image to use, you refer to its <em>target ID</em>
&mdash; an integer &mdash; as assigned by the android tool. The target ID is not
derived from the system image name, version, or API Level, or other attribute,
so you need to have the android tool list the available system images and the
target ID of each, as described in the next section. You should do this
<em>before</em> you run the <code>android create avd</code> command.
&mdash; an integer &mdash; as assigned by the <code>android</code> tool. The
target ID is not derived from the system image name, version, or API Level, or
other attribute, so you need to have the <code>android</code> tool list the
available system images and the target ID of each, as described in the next
section. You should do this <em>before</em> you run the <code>android create
avd</code> command.
</p>

<h3 id="listingtargets">Listing targets</h3>
@@ -131,7 +143,7 @@ target ID of each, as described in the next section. You should do this

<pre>android list targets</pre>

<p>The android tool scans the <code>&lt;sdk&gt;/platforms</code> and
<p>The <code>android</code> tool scans the <code>&lt;sdk&gt;/platforms</code> and
<code>&lt;sdk&gt;/add-ons</code> directories looking for valid system images and
then generates the list of targets. Here's an example of the command output:
</p>
@@ -199,24 +211,22 @@ system image in the list above): </p>
<pre>android create avd -n my_android1.5 -t 2</pre>

<p>If the target you selected was a standard Android system image ("Type:
platform"), the android tool next asks you whether you want to create a custom
hardware profile. </p>

platform"), the <code>android</code> tool next asks you whether you want to
create a custom hardware profile. </p>
<pre>Android 1.5 is a basic Android platform.
Do you wish to create a custom hardware profile [no]</pre>

<p>If you want to set custom hardware emulation options for the AVD, enter
"yes" and set values as needed. If you want to use the default hardware
emulation options for the AVD, just press the return key (the default is "no").
The android tool creates the AVD with name and system image mapping you
The <code>android</code> tool creates the AVD with name and system image mapping you
requested, with the options you specified. 

<p class="note">If you are creating an AVD whose target is an SDK add-on,
the android tool does not allow you to set hardware emulation options. It
assumes that the provider of the add-on has set emulation options appropriately
for the device that the add-on is modeling, and so prevents you from resetting
the options. </p>

<p class="note">If you are creating an AVD whose target is an SDK add-on, the
<code>android</code> tool does not allow you to set hardware emulation options.
It assumes that the provider of the add-on has set emulation options
appropriately for the device that the add-on is modeling, and so prevents you
from resetting the options. </p>
<p>For a list of options you can use in the <code>android create avd</code>
command, see the table in <a href="#options">Command-line options for AVDs</a>,
at the bottom of
@@ -225,11 +235,11 @@ this page. </p>
<h3 id="hardwareopts">Setting hardware emulation options</h3>

<p>When are creating a new AVD that uses a standard Android system image ("Type:
platform"), the android tool lets you set hardware emulation options for virtual
device. The table below lists the options available and the default values, as
well as the names of properties that store the emulated hardware options in the AVD's
configuration file (the config.ini file in the AVD's local directory). </p>

platform"), the <code>android</code> tool lets you set hardware emulation
options for virtual device. The table below lists the options available and the
default values, as well as the names of properties that store the emulated
hardware options in the AVD's configuration file (the config.ini file in the
AVD's local directory). </p>

<table>
<tr>
@@ -249,7 +259,6 @@ configuration file (the config.ini file in the AVD's local directory). </p>
<td>Whether there is a touch screen or not on the device. Default value is "yes".</td>
<td>hw.touchScreen


<tr>
<td>Trackball support </td>
<td>Whether there is a trackball on the device. Default value is "yes".</td>
@@ -339,23 +348,30 @@ configuration file (the config.ini file in the AVD's local directory). </p>
<td>Default value is "66MB".</td>
<td>disk.cachePartition.size </td>
</tr>

<tr>
<td>Abstracted LCD density</td>
<td>Sets the generalized density characteristic used by the AVD's screen. Default value is "160".</td>
<td>hw.lcd.density </td>
</tr>

</table>

<h3 id="location">Default location of the AVD files</h3>

<p>When you create an AVD, the android tool creates a dedicated directory for it
<p>When you create an AVD, the <code>android</code> tool creates a dedicated directory for it
on your development computer. The directory contains the AVD configuration file,
the user data image and SD card image (if available), and any other files
associated with the device. Note that the directory does not contain a system
image &mdash; instead, the AVD configuration file contains a mapping to the
system image, which it loads when the AVD is launched. </p>

<p>The android tool also creates a &lt;AVD name&gt;.ini file for the AVD at the
<p>The <code>android</code> tool also creates a &lt;AVD name&gt;.ini file for the AVD at the
root of the .android/avd directory on your computer. The file specifies the
location of the AVD directory and always remains at the root the .android 
directory.</p>

<p>By default, the android tool creates the AVD directory inside
<p>By default, the <code>android</code> tool creates the AVD directory inside
<code>~/.android/avd/</code> (on Linux/Mac), <code>C:\Documents and
Settings\&lt;user&gt;\.android\</code> on Windows XP, and 
<code>C:\Users\&lt;user&gt;\.android\</code> on Windows Vista. 
@@ -396,18 +412,18 @@ Error: Invalid value in image.sysdir. Run 'android update avd -n foo' </pre>

<h3 id="deleting">Deleting an AVD</h3>

<p>You can use the android tool to delete an AVD. Here is the command usage:</p>
<p>You can use the <code>android</code> tool to delete an AVD. Here is the command usage:</p>

<pre>android delete avd -n &lt;name&gt; </pre>

<p>When you issue the command, the android tool looks for an AVD matching the 
<p>When you issue the command, the <code>android</code> tool looks for an AVD matching the 
specified name deletes the AVD's directory and files. </p>


<h2 id="options">Command-line options for AVDs</h2>

<p>The table below lists the command-line options you can use with the 
android tool. </p>
<code>android</code> tool. </p>


<table>
@@ -448,9 +464,9 @@ android tool. </p>
  <td><code>-f</code></td>
  <td>Force creation of the AVD</td>
  <td>By default, if the name of the AVD being created matches that of an 
      existing AVD, the android tool will not create the new AVD or overwrite 
      existing AVD, the <code>android</code> tool will not create the new AVD or overwrite 
      the existing AVD. If you specify the <code>-f</code> option, however, the 
      android tool will automatically overwrite any existing AVD that has the 
      <code>android</code> tool will automatically overwrite any existing AVD that has the 
      same name as the new AVD. The files and data of the existing AVD are 
      deleted. </td>
</tr>
@@ -465,7 +481,7 @@ files.</td>
  <td><code>-s &lt;name&gt;</code> or <br>
      <code>-s &lt;width&gt;-&lt;height&gt;</code> </td>
  <td>The skin to use for this AVD, identified by name or dimensions.</td>
  <td>The android tool scans for a matching skin by name or dimension in the
  <td>The <code>android</code> tool scans for a matching skin by name or dimension in the
<code>skins/</code> directory of the target referenced in the <code>-t
&lt;targetID&gt;</code> argument. Example: <code>-s HVGA-L</code></td>
</tr>
Loading