diff options
author | Robert Ly <robertly@google.com> | 2011-01-04 22:48:02 -0800 |
---|---|---|
committer | Robert Ly <robertly@google.com> | 2011-01-07 18:54:44 -0800 |
commit | c74a69a89a0f65bca87520928a714ed20c45873d (patch) | |
tree | 9c5a6f1a84e9add42abf5754ce49cad02f618d4a /docs/html/guide | |
parent | ec5ca94cfae8b2b16aa5ecc6874f0f3b80dde7df (diff) | |
download | frameworks_base-c74a69a89a0f65bca87520928a714ed20c45873d.zip frameworks_base-c74a69a89a0f65bca87520928a714ed20c45873d.tar.gz frameworks_base-c74a69a89a0f65bca87520928a714ed20c45873d.tar.bz2 |
Doc Change: Fixing broken links and miscellaneous text revisions to support link fixing
Change-Id: I192595a3c7af520bf8598e80ae25d0dea289fcbd
Diffstat (limited to 'docs/html/guide')
-rw-r--r-- | docs/html/guide/developing/building/building-cmdline.jd | 2 | ||||
-rw-r--r-- | docs/html/guide/developing/devices/managing-avds.jd | 8 | ||||
-rw-r--r-- | docs/html/guide/developing/index.jd | 19 | ||||
-rw-r--r-- | docs/html/guide/developing/projects/index.jd | 81 | ||||
-rw-r--r-- | docs/html/guide/developing/testing/testing_eclipse.jd | 5 | ||||
-rw-r--r-- | docs/html/guide/developing/testing/testing_otheride.jd | 2 | ||||
-rw-r--r-- | docs/html/guide/guide_toc.cs | 14 | ||||
-rw-r--r-- | docs/html/guide/publishing/app-signing.jd | 8 | ||||
-rw-r--r-- | docs/html/guide/publishing/licensing.jd | 30 | ||||
-rw-r--r-- | docs/html/guide/tutorials/hello-world.jd | 13 |
10 files changed, 132 insertions, 50 deletions
diff --git a/docs/html/guide/developing/building/building-cmdline.jd b/docs/html/guide/developing/building/building-cmdline.jd index 934e936..f40ad04 100644 --- a/docs/html/guide/developing/building/building-cmdline.jd +++ b/docs/html/guide/developing/building/building-cmdline.jd @@ -1,4 +1,4 @@ -page.title=Building and Running Apps in Other IDEs +page.title=Building and Running Apps on the Command Line @jd:body <div id="qv-wrapper"> diff --git a/docs/html/guide/developing/devices/managing-avds.jd b/docs/html/guide/developing/devices/managing-avds.jd index 73a6b6c..27d2b55 100644 --- a/docs/html/guide/developing/devices/managing-avds.jd +++ b/docs/html/guide/developing/devices/managing-avds.jd @@ -6,7 +6,11 @@ page.title=Creating and Managing AVDs with AVD Manager <h2>In this document</h2> <ol> - <li><a href="#AVDEclipse">Creating an AVD</a></li> + <li><a href="#createavd">Creating an AVD</a> + <ol> + <li><a href="#hardwareopts">Hardware options</a></li> + </ol> + </li> </ol> </div> </div> @@ -25,7 +29,7 @@ page.title=Creating and Managing AVDs with AVD Manager of each AVD. </p> - <h2>Creating an AVD</h2> + <h2 id="createavd">Creating an AVD</h2> <p>You can create as many AVDs as you would like to test on. It is recommended that you test your applications on all API levels higher than the target API level for your application.</p> diff --git a/docs/html/guide/developing/index.jd b/docs/html/guide/developing/index.jd index 879986c..f19f97e 100644 --- a/docs/html/guide/developing/index.jd +++ b/docs/html/guide/developing/index.jd @@ -23,32 +23,33 @@ page.title=Overview before continuing.</p> </li> - <li> - <a href="{@docRoot}guide/developing/devices/avds-devices.html">Set up Android Virtual Devices - or hardware devices</a>. + <li>Set up Android Virtual Devices or hardware devices</a>. <p>You need to create Android Virtual Devices (AVD) or connect hardware devices on which you will install your applications.</p> + + <p>See <a href="{@docRoot}guide/developing/devices/index.html">Creating and Managing Virtual Devices</a> + and <a href="{@docRoot}guide/developing/device.html">Connecting Hardware Devices</a> for more information. </li> <li> - <a href="{@docRoot}guide/developing/projects/projects.html">Create an Android project</a>. + <a href="{@docRoot}guide/developing/projects/index.html">Create an Android project</a>. <p>An Android project contains all source code and resource files for your application. It is built into an <code>.apk</code> package that you can install on Android devices.</p> </li> <li> - <a href="{@docRoot}guide/developing/building/building.html">Build and run your + <a href="{@docRoot}guide/developing/building/index.html">Build and run your application</a>. <p>If you are using Eclipse, builds are generated each time you save changes and you can install your application on a device by clicking <strong>Run</strong>. If you're using another IDE, you can build your - project using Ant and install it on a device using ADB.</p> + project using Ant and install it on a device using <code>adb</code>.</p> </li> <li> - <a href="{@docRoot}guide/developing/debugging/debugging.html">Debug your application with the + <a href="{@docRoot}guide/developing/debugging/index.html">Debug your application with the SDK debugging and logging tools</a>. <p>Debugging your application involves using a JDWP-compliant debugger along with the @@ -110,6 +111,6 @@ page.title=Overview Eclipse, such as the <code>adb</code> shell commands. You might also need to call Keytool and Jarsigner to sign your applications, but you can set up Eclipse to do this automatically as well.</p> - <p>For more information on these tools, see the <a href="@{docRoot}guide/developing/tools/index.html"> - Tools</a> section of the documentation.</p> + <p>For more information on the tools provided with the Android SDK, see the + <a href="{@docRoot}guide/developing/tools/index.html">Tools</a> section of the documentation.</p> diff --git a/docs/html/guide/developing/projects/index.jd b/docs/html/guide/developing/projects/index.jd index 1daf738..45fd5a1 100644 --- a/docs/html/guide/developing/projects/index.jd +++ b/docs/html/guide/developing/projects/index.jd @@ -8,7 +8,11 @@ page.title=Creating and Managing Projects <ol> <li><a href="#ApplicationProjects">Android Projects</a></li> - <li><a href="#LibraryProjects">Library Projects</a></li> + <li><a href="#LibraryProjects">Library Projects</a> + <ol> + <li><a href="#libraryMigrating">Migrating library projects to ADT 0.9.8 or higher</a></li> + </ol> + </li> <li><a href="#TestProjects">Test Projects</a></li> </ol> @@ -418,6 +422,81 @@ page.title=Creating and Managing Projects project can reference the library project through a relative link.</p></li> </ul> + + + <h3 id="libraryMigrating">Migrating library projects to ADT 0.9.8 or higher</h3> + +<p>This section provides information about how to migrate a library project +created with ADT 0.9.7 to ADT 0.9.8 or higher. The migration is needed only if +you are developing in Eclipse with ADT and assumes that you have also upgraded +to SDK Tools r7 (or higher). </p> + +<p>The way that ADT handles library projects has changed between +ADT 0.9.7 and ADT 0.9.8. Specifically, in ADT 0.9.7, the <code>src/</code> +source folder of the library was linked into the dependent application project +as a folder that had the same name as the library project. This worked because +of two restrictions on the library projects:</p> + +<ul> +<li>The library was only able to contain a single source folder (excluding the +special <code>gen/</code> source folder), and</li> +<li>The source folder was required to have the name <code>src/</code> and be +stored at the root of the project.</li> +</ul> + +<p>In ADT 0.9.8, both of those restrictions were removed. A library project can +have as many source folders as needed and each can have any name. Additionally, +a library project can store source folders in any location of the project. For +example, you could store sources in a <code>src/java/</code> directory. In order +to support this, the name of the linked source folders in the main project are +now called <library-name>_<folder-name> For +example: <code>MyLibrary_src/</code> or <code>MyLibrary_src_java/</code>.</p> + +<p>Additionally, the linking process now flags those folders in order for ADT to +recognize that it created them. This will allow ADT to automatically migrate the +project to new versions of ADT, should they contain changes to the handling of +library projects. ADT 0.9.7 did not flag the linked source folders, so ADT 0.9.8 +cannot be sure whether the old linked folders can be removed safely. After +upgrading ADT to 0.9.8, you will need to remove the old linked folders manually +in a simple two-step process, as described below.</p> + +<p>Before you begin, make sure to create a backup copy of your application or +save the latest version to your code version control system. This ensures that +you will be able to easily revert the migration changes in case there is a +problem in your environment.</p> + +<p>When you first upgrade to ADT 0.9.8, your main project will look as shown +in figure 1, with two linked folders (in this example, <code>MyLibrary</code> and +<code>MyLibrary_src</code> — both of which link to +<code>MyLibrary/src</code>. Eclipse shows an error on one of them because they +are duplicate links to a single class.</p> + +<img src="/images/developing/lib-migration-0.png" alt=""> +<p class="img-caption"><strong>Figure 1.</strong> Library project migration error</p> +<p>To fix the error, remove the linked folder that <em>does not</em> contain the +<code>_src</code> suffix. </p> + +<ol> +<li>Right click the folder that you want to remove (in this case, the +<code>MyLibrary</code> folder) and choose <strong>Build Path</strong> > +<strong>Remove from Build Path</strong>, as shown in figure 2.</li> + +<img src="/images/developing/lib-migration-1.png" style="height:600px" +alt=""> +<p class="img-caption"><strong>Figure 2.</strong> Remove from Build Path menu item</p> + +<li>Next, when asked about unlinking the folder from the project, select +<strong>Yes</strong>, as shown in figure 3.</li> + +<img src="/images/developing/lib-migration-2.png" alt=""> + +<p class="img-caption"><strong>Figure 3.</strong> Unlink folder confirmation window</p> +</ol> + +<p>This should resolve the error and migrate your library project to the new +ADT environment. </p> + + <h2 id="TestProjects">Test Projects</h2> diff --git a/docs/html/guide/developing/testing/testing_eclipse.jd b/docs/html/guide/developing/testing/testing_eclipse.jd index 370c142..1b9c6b1 100644 --- a/docs/html/guide/developing/testing/testing_eclipse.jd +++ b/docs/html/guide/developing/testing/testing_eclipse.jd @@ -12,9 +12,10 @@ page.title=Testing In Eclipse, with ADT </div> <p> This topic explains how create and run tests of Android applications in Eclipse with ADT. - Before you read this topic, you should read about how to create a Android application with the + Before you read this topic, you should read about how to create an Android application with the basic processes for creating and running applications with ADT, as described in - <a href="{@docRoot}guide/developing/eclipse-adt.html">Developing In Eclipse, with ADT</a>. + <a href="{@docRoot}guide/developing/projects/projects-eclipse.html">Creating and Managing Projects in Eclipse</a> + and <a href="guide/developing/building/building-eclipse.html">Building and Running Apps in Eclipse</a>. You may also want to read <a href="{@docRoot}guide/topics/testing/testing_android.html">Testing Fundamentals</a>, which provides an overview of the Android testing framework. diff --git a/docs/html/guide/developing/testing/testing_otheride.jd b/docs/html/guide/developing/testing/testing_otheride.jd index adb0efa..48fa032 100644 --- a/docs/html/guide/developing/testing/testing_otheride.jd +++ b/docs/html/guide/developing/testing/testing_otheride.jd @@ -133,7 +133,7 @@ android create test-project -m <main_path> -n <project_name> -p < This creates a new test project with the appropriate directories and build files. The directory structure and build file contents are identical to those in a regular Android application project. They are described in detail in the topic - <a href="{@docRoot}guide/developing/other-ide.html">Developing In Other IDEs</a>. + <a href="{@docRoot}guide/developing/projects/index.html">Creating and Managing Projects</a>. </p> <p> The operation also creates an <code>AndroidManifest.xml</code> file with instrumentation diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index 401337a..a984acd 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -311,7 +311,7 @@ <!--<li><a href="">Developing for Android</a></li> signing, upgrading, selecting a package name, select device profile, touch, trackball, dpad available, etc. --> <li> - <a href="<?cs var:toroot ?>guide/developing/overview.html"> + <a href="<?cs var:toroot ?>guide/developing/index.html"> <span class="en">Overview</span></a> </li> @@ -354,7 +354,7 @@ <ul> <li> <a href="<?cs var:toroot ?>guide/developing/projects/projects-eclipse.html"> - <span class="en">In Eclipse</span> + <span class="en">In Eclipse with ADT</span> </a> </li> <li> @@ -373,9 +373,9 @@ </div> <ul> <li><a href="<?cs var:toroot ?>guide/developing/building/building-eclipse.html"> - <span class="en">In Eclipse</span> + <span class="en">In Eclipse with ADT</span> </a></li> - <li><a href="<?cs var:toroot ?>guide/developing/building/building-cmdline.html"><span class="en">In Other IDEs</span></a></li> + <li><a href="<?cs var:toroot ?>guide/developing/building/building-cmdline.html"><span class="en">On the Command Line</span></a></li> </ul> </li> @@ -388,7 +388,7 @@ <ul> <li> <a href="<?cs var:toroot ?>guide/developing/debugging/debugging-projects.html"> - <span class="en">In Eclipse</span> + <span class="en">In Eclipse with ADT</span> </a> </li> <li> @@ -433,13 +433,13 @@ <ul> <li> <a href="<?cs var:toroot ?>guide/developing/testing/testing_eclipse.html"> - <span class="en">Testing in Eclipse, with ADT</span> + <span class="en">In Eclipse with ADT</span> </a> </li> <li> <a href="<?cs var:toroot ?>guide/developing/testing/testing_otheride.html"> - <span class="en">Testing in Other IDEs</span> + <span class="en">In Other IDEs</span> </a> </li> </ul> diff --git a/docs/html/guide/publishing/app-signing.jd b/docs/html/guide/publishing/app-signing.jd index 101646e..93077a0 100644 --- a/docs/html/guide/publishing/app-signing.jd +++ b/docs/html/guide/publishing/app-signing.jd @@ -240,8 +240,8 @@ is enabled by using the <code>debug</code> option with the <code>ant</code> comm compile your app, the build script generates a keystore/key and signs the .apk for you. The script then also aligns the .apk with the <code>zipalign</code> tool. No other action on your part is needed. Read -<a href="{@docRoot}guide/developing/other-ide.html#DebugMode">Developing In Other IDEs: Building -in debug mode</a> for more information.</p> +<a href="{@docRoot}guide/developing/building/building-cmdline.html#DebugMode">Building and Running Apps +on the Command Line</a> for more information.</p> <h3 id="debugexpiry">Expiry of the Debug Certificate</h3> @@ -441,8 +441,8 @@ file in {@code bin/} will instead be <code><em><your_project_name></em>-release.apk</code>. With these steps automated for you, you're able to skip the manual procedures below (steps 3 and 4). To learn how to specify your keystore and alias in the {@code build.properties} file, -see <a href="{@docRoot}guide/developing/other-ide.html#ReleaseMode">Developing In Other -IDEs: Building in release mode</a>.</p> +see <a href="{@docRoot}guide/developing/building/building-cmdline.html#ReleaseMode"> +Building and Running Apps on the Command Line</a>.</p> diff --git a/docs/html/guide/publishing/licensing.jd b/docs/html/guide/publishing/licensing.jd index 40439f0..e099413 100644 --- a/docs/html/guide/publishing/licensing.jd +++ b/docs/html/guide/publishing/licensing.jd @@ -518,7 +518,7 @@ Android Virtual Devices.</li> </ol> <p>If you are not familiar with AVDs or how to use them, see <a -href="{@docRoot}guide/developing/tools/avd.html">Android Virtual Devices</a>.</p> +href="{@docRoot}guide/developing/devices/index.html">Creating and Managing Virtual Devices</a>.</p> <h4 id="project-update">Updating your project configuration</h4> @@ -628,12 +628,9 @@ version of the LVL.</p> share its code and resources across multiple applications. </p> <p style="margin-top:.5em;">If you aren't familiar with library projects or how -to use them, read more in <a -href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing in -Eclipse with ADT</a> or <a -href="{@docRoot}guide/developing/other-ide.html#libraryProject">Developing in -Other IDEs</a>, as appropriate for your environment.</p> - +to use them, see <a href="{@docRoot}guide/developing/projects/index.html#LibraryProjects"> +Creating and Managing Projects</a>. +</p> </div> </div> @@ -669,9 +666,8 @@ predefined as a library project in its <code>default.properties</code> file, so no further configuration is needed. </p> <p>For more information about how to create an application project or work with -library projects in Eclipse, see <a -href="{@docRoot}guide/developing/eclipse-adt.html#CreatingAProject">Developing -in Eclipse with ADT</a>.</p> +library projects in Eclipse, see <a href="{@docRoot}guide/developing/projects/projects-eclipse.html"> +Creating and Managing Projects in Eclipse</a></p>. <h4>Copying the LVL sources to your application</h4> @@ -701,9 +697,9 @@ haven't done that already, do it now before continuing. </p> <p>Next, open the application's project properties window, as shown below. Select the "Android" properties group and click <strong>Add</strong>, then choose the LVL library project (com_android_vending_licensing) and click -<strong>OK</strong>. For more information, see -<a href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing -in Eclipse with ADT</a></p> +<strong>OK</strong>. For more information, see +<a href="{@docRoot}developing/projects/projects-eclipse.html#SettingUpLibraryProject"> +Creating and Managing Projects in Eclipse</a></p>. <div style="margin-bottom:2em;"> @@ -730,11 +726,9 @@ properties, including the reference to the library project:</p> --library <em>path/to/my/library_project</em> </pre> -<p>For more information about working with library projects, see <a -href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing -in Eclipse with ADT</a> or <a -href="{@docRoot}guide/developing/other-ide.html#libraryProject">Developing in -Other IDEs</a>, as appropriate for your environment.</p> +<p>For more information about working with library projects, +see <a href="{@docRoot}developing/projects/projects-cmdline.html#SettingUpLibraryProject"> +Creating and Managing Projects on the Command Line</a></p>. <h2 id="app-integration">Integrating the LVL with Your Application</h2> diff --git a/docs/html/guide/tutorials/hello-world.jd b/docs/html/guide/tutorials/hello-world.jd index 6e315b2..11e6497 100644 --- a/docs/html/guide/tutorials/hello-world.jd +++ b/docs/html/guide/tutorials/hello-world.jd @@ -23,9 +23,11 @@ It's particularly easy if you're using Eclipse as your IDE, because we've provid great plugin that handles your project creation and management to greatly speed-up your development cycles.</p> -<p>If you're not using Eclipse, that's okay. Familiarize yourself with -<a href="{@docRoot}guide/developing/other-ide.html">Developing in Other IDEs</a>. -You can then return to this tutorial and ignore anything about Eclipse.</p> +<p>If you are not using Eclipse, the tools provided by the Android SDK are accessible +on the command line, so you can choose your IDE or text editor. +For more information about developing with the Android SDK tools, see +the <a href="{@docRoot}guide/developing/index.html">Overview</a> +section for developing on Android.</p> <p>Before you start, you should already have the very latest SDK installed, and if you're using Eclipse, you should have installed the ADT plugin as well. If you have not installed these, see @@ -562,5 +564,6 @@ android create project \ <p>This creates the required folders and files for the project at the location defined by the <em>path</em>.</p> - <p>For more information on how to use the SDK tools to create and build projects, please read -<a href="{@docRoot}guide/developing/other-ide.html">Developing in Other IDEs</a>.</p> + <p>For more information on how to use the SDK tools to create and build projects on the command line, read +<a href="{@docRoot}guide/developing/projects/index.html">Creating and Managing Projects on the Command Line</a> and +<a href="{@docRoot}guide/developing/building/building-cmdline.html">Building and Running Apps on the Command Line</a>.</p> |