LineageOS/android_development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleaning up source.android.com files.

Browse Source 
This change fixes some formatting artifacts that resulted from the export from
Sites, and also updates links to no longer point to Sites and use the standard
{@docRoot} idiom. Also contains a few content updates, and introduces a page
about branch management.
This commit is contained in:
Dan Morrill
2009-11-15 11:49:30 -08:00
parent 75c64ade6a
commit a9788cd98f
33 changed files with 352 additions and 574 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pdk/docs/about/philosophy.jd
View File

@@ -1,7 +1,6 @@
page.title=Philosophy and Goals
doc.type=about
@jd:body
<div id="mainBodyFixed">
<p>Android is an open-source software stack for mobile phones and similar
devices. The Android Open Source Project is tasked with maintaining current
and developing new versions of the Android software. We believe that users
@@ -77,4 +76,3 @@ we ship high-quality, flagship devices with an intense product and end-user
focus. The "next release" of Android is driven by the product needs for the next
generation of mobile devices; the resulting excellent product is then released
to open source and becomes the new current version of the platform.</p>
</div>

19
pdk/docs/community/groups-charter.jd
View File

@@ -1,24 +1,6 @@
page.title=Android Discussion Groups Charter
doc.type=community
@jd:body
<h3><b>Android mailing lists charter</b>
</h3>
<div><div><div><div><div><p><b>Contents</b>
</p>
<ol><li><a href="#TOC-Audience"><b>1</b>
Audience</a>
</li>
<li><a href="#TOC-Mailing-list-rules"><b>2</b>
Mailing list rules</a>
</li>
<li><a href="#TOC-Contacting-the-moderators"><b>3</b>
Contacting the moderators</a>
</li>
</ol>
</div>
</div>
</div>
</div>
<h2>
Audience
</h2>
@@ -47,4 +29,3 @@ Contacting the moderators
</p>
<p>But if you see an outrageous violation, want to report spam, feel very strongly about something, or even if you just want to chat, then contact the mailing list's owners. It's what we're here for!
</p>
</div>

32
pdk/docs/community/index.jd
View File

@@ -34,21 +34,23 @@ href="http://developer.android.com/community/index.html">http://developer.androi
read <a href="http://www.catb.org/%7Eesr/faqs/smart-questions.html">How To
Ask Questions The Smart Way</a>.</li>
</ol>
<h2>Open Source Project discussions</h2>
<ul>
<li><b>android-building</b><br/>
Subscribe to this list for discussion and help on building the Android source
code, and on the build system. If you've just checked out the source code and
have questions about how to turn it into binaries, start here.<br/><br/>
Subscribe using Google Groups: <a
href="http://groups.google.com/group/android-building">android-building</a><br/>
Subscribe via email: <a href="mailto:android-building+subscribe@googlegroups.com">android-building+subscribe@googlegroups.com</a>
</li>
<li><b>android-platform</b><br/>
This list is for developers who want to contribute code to the Android
user-space projects, such as the core system libraries, the Android
services, the public APIs, or the built-in applications. Before posting,
please be sure you've downloaded the source code, compiled it, read through
it, and are at the point where you're going to be making changes of your own
to contribute into the Android source code. You can use this list to
coordinate your efforts with those of other contributors, and
discuss architecture, design and implementation. Please use android-kernel for
discussions about contributing to the kernel, android-porting if you're
porting Android to your own hardware or making changes that you're not going
to contribute back, android-developers if you're writing applications with the
SDK, or android-discuss for everything else.<br/><br/>
services, the public APIs, or the built-in applications. Note: contributors
to the Android kernel should go to the android-kernel list, below.<br/><br/>
Subscribe using Google Groups: <a
href="http://groups.google.com/group/android-platform">android-platform</a><br/>
Subscribe via email: <a href="mailto:android-platform+subscribe@googlegroups.com">android-platform+subscribe@googlegroups.com</a>
@@ -77,16 +79,6 @@ Subscribe using Google Groups: <a
href="http://groups.google.com/group/android-kernel">android-kernel</a><br/>
Subscribe via email: <a href="mailto:android-kernel+subscribe@googlegroups.com">android-kernel+subscribe@googlegroups.com</a>
</li>
<li><b>Repo and Gerrit discussion</b><br/>
This list is for discussions on everything related to the process used to
manage the Android source code with repo and gerrit: downloading the source
code, submitting changes for review, commenting on code being reviewed,
submitting changes for the world to enjoy.<br/><br/>
Subscribe using Google Groups: <a
href="http://groups.google.com/group/repo-discuss">repo-discuss</a><br/>
Subscribe via email: <a href="mailto:repo-discuss+subscribe@googlegroups.com">repo-discuss+subscribe@googlegroups.com</a>
</li>
</ul>
<h2>Using email with Google Groups</h2>

5
pdk/docs/compatibility/contact-us.jd
View File

@@ -1,8 +1,7 @@
page.title=Android Compatibility - Contact Us
page.title=Contact Us
doc.type=compatibility
@jd:body
<h3><b>Mailing list</b>
</h3>
<h3><b>Mailing list</b></h3>
<div><div>Welcome to the Android compatibility mailing list!<br>
To get the most out of the mailing list discussions, please do the following before you post:
<ol><li><b>Read the <a href="http://sites.google.com/a/android.com/opensource/discuss/android-discussion-groups-charter">mailing list charter</a>

12
pdk/docs/compatibility/cts-intro.jd
View File

@@ -1,16 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Compatibility Test Suite
doc.type=compatibility
@jd:body
<h3><b>Compatibility test suite (CTS)</b>
</h3>
<b>Contents</b>
<ol>
<li><a href="#TOC-How-does-the-CTS-work-">How does the CTS work?</a></li>
<li><a href="#TOC-Workflow">Workflow</a></li>
<li><a href="#TOC-Types-of-test-cases">Types of test cases</a></li>
<li><a href="#TOC-Areas-Covered">Areas Covered</a></li>
</ol>
<h3>How does the CTS work?</h3>
<div><img src="{@docRoot}images/cts-0.png"></div>
<div>The CTS is an automated testing harness that includes two major software components:</div>

26
pdk/docs/compatibility/faq.jd
View File

@@ -1,31 +1,7 @@
page.title=Android Compatibility - Frequently Asked Questions
page.title=Frequently Asked Questions
doc.type=compatibility
@jd:body
<h3><b>Compatibility FAQ</b></h3>
<div><div><div><div><div><div><p><b>Contents</b>
</p>
<ol><li><a href="#TOC-The-CTS-report-shows-test-failures-"><b>1</b>
The CTS report shows test failures -- what should I do now?</a>
</li>
<li><a href="#TOC-Android-1.5-CTS-r1-known-issues"><b>2</b>
Android 1.5 CTS r1 known issues</a>
</li>
<li><a href="#TOC-Can-I-remove-the-final-modifier-fro"><b>3</b>
Can I remove the 'final' modifier from classes in the Android public APIs and still be an Android-compatible device?</a>
</li>
<li><a href="#TOC-I-see-a-failure-in-my-report-with-t"><b>4</b>
I see a failure in my report with the comment "A test that was a known failure actually passed. Please check." -- what does this mean?</a>
</li>
<li><a href="#TOC-Why-are-compass-and-accelerometer-r"><b>5</b>
Why are compass and accelerometer required for Android compatibility?</a>
</li>
</ol>
</div>
</div>
</div>
</div>
</div>
<h3>
The CTS report shows test failures -- what should I do now?
</h3>

17
pdk/docs/compatibility/index.jd
View File

@@ -2,10 +2,16 @@ page.title=Android Compatibility
doc.type=compatibility
@jd:body
<p>Android is an open source product, and anyone can use the source code to build
devices. Incautious implementations, however, can easily introduce bugs that
cause third-party applications to break. The purpose of the Android
Compatibility Program is to help Android device implementations remain
compatible with all apps.</p>
devices. The purpose of the Android compatibility program is to help Android
device implementations remain compatible with all apps.</p>
<p>A device is considered compatible if existing and new third-party
applications run correctly on it. Poor device implementations that change APIs
or alter behaviors will break these apps and so are not compatible. The
Android compatibility program's aim is to ensure that these APIs are
consistently implemented across devices.</p>
<p>The latest version of the Android source code and compatibility program is
1.6, which roughly corresponded to the Donut branch. The compatibility
program for Android 2.x (corresponding to Eclair) is coming soon.</p>
<h2>Why build compatible Android devices?</h2>
<h3>Users want a customizable device.</h3>
<p>A mobile phone is a highly personal, always-on, always-present gateway to
@@ -41,7 +47,8 @@ href="{@docRoot}compatibility/overview.html">the program overview</a>.</p>
This document enumerates the software and the hardware features of
a compatible Android device.</p></li>
<li><b>Pass the Compatibility Test Suite (CTS)</b><p>You can use the CTS
as an ongoing aid to compatibility during the development process.</p></li>
(included in the Android source code) as an ongoing aid to compatibility
during the development process.</p></li>
<li><b>Submit CTS report</b><p>[Optional] You can also submit your CTS report,
so that it can be validated and recorded.</p><p><i>Note:
the submission system is currently under construciton, and is not currently

2
pdk/docs/downloads/index.jd
View File

@@ -2,7 +2,6 @@ page.title=Downloads
doc.type=downloads
doc.hidenav=true
@jd:body
<div id="mainBodyFixed">
<p>This page provides access to various downloads. Note that if you're looking
for the Android SDK (for application developers), you should visit <a
href="http://developer.android.com/sdk/index.html">developer.android.com</a>.</p>
@@ -43,4 +42,3 @@ there is no compatibility program for Android 1.5 and earlier. Note also that
there is no compatibility program for Android 2.0, since it was superceded by
Android 2.1 after only a few weeks.
</p>
</div>

BIN
pdk/docs/images/code-lines.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 233 KiB

2
pdk/docs/porting/bluetooth/bluetooth_process.jd
View File

@@ -1,6 +1,6 @@
page.title=Bluetooth Process Diagram
pdk.version=1.0
doc.type=guide
doc.type=porting
@jd:body
<p>The diagram below offers a process-oriented architectural overview of Android's Bluetooth stack. Click <a href="../bluetooth.html">Bluetooth</a> to return to the Bluetooth overview page.</p>

2
pdk/docs/porting/index.jd
View File

@@ -21,7 +21,7 @@ doc.type=porting
<p>If you are new to Android, start with the platform documentation on the following sites:
<ul>
<li><a href="http://developer.android.com">Android Developers site</a>: This site offers high-level platform documentation and architecture concepts.</li>
<li><a href="http://source.android.com">Android Open Source Project site</a>: This site provides instructions on how to get the source code, establish a development environment, and perform a simple build.</li>
<li><a href="{@docRoot}">Android Open Source Project site</a>: This site provides instructions on how to get the source code, establish a development environment, and perform a simple build.</li>
</ul>
<p>When you are ready to start customizing the platform or porting to your target hardware, start in this guide with the <a href="build_system.html">Build System overview</a>.</p>

13
pdk/docs/source/building-dream.jd
View File

@@ -1,9 +1,12 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Building for ADP1
doc.type=source
@jd:body
<h3><b>Building For Dream</b>
</h3>
<div>The basic manifest for cupcake (and above) defines which projects are needed to do a generic build for the emulator or for unlocked Dream devices (e.g. the Android Dev Phone 1). You need to have an appropriate device running a matching official image.<br><br>To build donut or master for dream (your device needs to be an ADP1 running an official 1.6 system):<br><ol><li>Follow the<a href="http://source.android.com/download">normal steps</a>
<div>The basic manifest for cupcake (and above) defines which projects are
needed to do a generic build for the emulator or for unlocked Dream devices
(e.g. the Android Dev Phone 1). You need to have an appropriate device running
a matching official image.<br><br>To build donut or master for dream (your
device needs to be an ADP1 running an official 1.6 system):<br><ol><li>Follow
the <a href="{@docRoot}source/download.html">normal steps</a>
to setup repo and check out the sources.
</li>
<li>At the root of your source tree, run ". build/envsetup.sh" like you normally would for an emulator build.
@@ -17,7 +20,7 @@ to setup repo and check out the sources.
</li>
<li>from this point, the fastboot tool (which is put automatically in your path) can be used to flash a device: boot the device into the bootloader by holding the back key while pressing the power key, and run "fastboot -w flashall".<br></li>
</ol>
To build cupcake for dream (your device needs to be an ADP1 running an official 1.5 system):<br><ol><li>Follow the<a href="http://source.android.com/download">normal steps</a>
To build cupcake for dream (your device needs to be an ADP1 running an official 1.5 system):<br><ol><li>Follow the <a href="{@docRoot}source/download.html">normal steps</a>
to setup repo and check out the sources.
</li>
<li>At the root of your source tree, run ". build/envsetup.sh" like you normally would for an emulator build.

4
pdk/docs/source/cla-corporate.jd
View File

@@ -1,8 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Corporate Contributor License Agreement
doc.type=source
@jd:body
<h3><b>Corporate Contributor License Grant - Android Open Source Project</b>
</h3>
<div><p>In order to clarify the intellectual property license granted with Contributions from any person or entity, the Android Open Source Project (the "Project") must have a Contributor License Grant ("Grant") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the Project and the Android Open Source Project Leads (the "Project Leads"); it does not change your rights to use your own Contributions for any other purpose.
</p>
<p>This version of the Grant allows an entity (the "Corporation") to submit Contributions to the Project Leads, to authorize Contributions submitted by its designated employees to the Project Leads, and to grant copyright and patent licenses thereto. If you have not already done so, please complete and send an original signed Grant to

4
pdk/docs/source/cla-individual.jd
View File

@@ -1,8 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Contributor License Agreement for Individuals
doc.type=source
@jd:body
<h3><b>Individual Contributor License Grant - Android Open Source Project</b>
</h3>
<div><p><i>Please visit the <a href="https://review.source.android.com/#settings,new-agreement">code review tool</a>
to execute the grant online.This page provides the text of the Individual Contributor License Grant for your quick review.</i>
<br></p>

77
pdk/docs/source/code-lines.jd Normal file
View File

@@ -0,0 +1,77 @@
page.title=Android Code-Lines
doc.type=source
@jd:body
<p>The Android Open Source Project maintains a complete software stack intended
to be ported by OEMs and other device implementors to run on actual hardware.
Accordingly, we maintain a number of "code lines" to clearly separate the
current stable version of Android from unstable experimental work.</p>
<p>The chart below depicts at a conceptual level how AOSP manages code and
releases. We're referring to these as "code lines" instead of "branches"
simply because at any given moment there may be more than one branch extant
for a given "code line". For instance, when a release is cut, sometimes that
will become a new branch in git, and sometimes not, based on the needs of the
moment.</p>
<img src="{@docRoot}images/code-lines.png"/>
<h3>Notes and Explanations</h3>
<ul>
<li>A <i>release</i> corresponds to a formal version of the Android platform, such
as 1.5, 2.0, and so on. Generally speaking, a release of the platform
corresponds to a version of the <code>SdkVersion</code> field used in
AndroidManifest.xml files, and defined in <code>frameworks/base/api</code> in
the source tree.</li>
<li>An <i>upstream</i> project is an open-source project from which the Android
stack is pulling code. These include obvious projects such as the Linux kernel
and WebKit, but over time we are migrating some of the semi-autonomous
Android projects (such as Dalvik, the Android SDK tools, Bionic, and so on) to
work as "upstream" projects. These will be developed entirely in the public
tree, and snapshots will be periodically pulled into releases.</li>
<li>The diagram refers to "Eclair" and "Flan"; however, they are simply
placeholders, and the diagram actually reflects the overall release and
branching strategy.</li>
<li>At all times, the Release code-line (which may actually consist of
more than one actual branch in git) is considered the sole canonical source
code for a given Android platform. OEMs and other groups building devices
should pull only from a Release branch.</li>
<li>We will be setting up an "Experimental" code-line to capture changes from
the community, so that they can be iterated on, with an eye toward stability.</li>
<li>Changes that prove stable will eventually be pulled into a Release
branch. Note that this will only apply to bug fixes, app improvements, and
other things that do not affect the APIs of the platform.</li>
<li>Changes will be pulled into Release branches from upstream projects
(include the Android "upstream" projects) as necessary.</li>
<li>The "n+1"th version (that is, next major version of the framework and
platform APIs) will be developed by Google internally. (See below for
details.)</li>
<li>Changes will be pulled from upstream, Release, and Experimental branches
into Google's private branch as necessary.</li>
<li>When the platform APIs for the next version have stabilized and been fully
tested, Google will cut a release of the next platform version. (This
specifically refers to a new <code>SdkVersion</code>.) This will also
correspond to the internal code-line being made a public Release branch, and the
new current platform code-line.</li>
<li>When a new platform version is cut, a corresponding Experimental
code-line.</li>
</ul>
<h3>About Private Code-Lines</h3>
<p>The source management strategy above includes a code-line that Google will
keep private. The reason for this is to focus attention on the current public
version of Android.</p>
<p>OEMs and other device builders naturally want to ship devices with the
latest version of Android. Similarly, application developers don't want to
deal with more extant platform versions than strictly necessary. Meanwhile,
Google retains responsibility for the strategic direction of Android as a
platform and a product. Our approach is based on focusing on a small number of
flagship devices to drive features, and secure protections of Android-related
intellectual property through patents and the like.</p>
<p>As a result, Google frequently has possession of confidential
information of third parties, and we must refrain from revealing patentable
features until we've secured the appropriate protections. Meanwhile, there are
real risks to the platform arising from having too many platform versions
extant at once. For these reasons, we have structured the open-source project
-- including third-party contributions -- to focus on the currently-public
stable version of Android. "Deep development" on the next version of the
platform will happen in private, until it's ready to become an official
release.</p>
<p>We recognize that many contributors will disagree with this approach. We
respect that others may have a different point of view; however, this is the
approach that we feel is best, and the one we've chosen to implement.</p>

4
pdk/docs/source/code-style.jd
View File

@@ -1,8 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Code Style Guidelines for Contributors
doc.type=source
@jd:body
<h3><b>Code Style Guide</b>
</h3>
<div>
<h1>Android Code Style Rules</h1>
<p>The rules below are not guidelines or recommendations, but strict rules.<b>You may not disregard the rules we list below</b>

4
pdk/docs/source/documentation.jd
View File

@@ -1,8 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Documentation Resources
doc.type=source
@jd:body
<h3><b>Documentation</b>
</h3>
<div><p>
As this page grows, it will include resources for wireless operators and handset manufacturers as well as for platform developers.<br></p>
<h3>

94
pdk/docs/source/download.jd
View File

@@ -1,83 +1,16 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Get Android Source Code
doc.type=source
@jd:body
<h3><span><b>Get source</b>
</span>
</h3>
<div><div><div><div><div><div><div><div><p><b>Contents</b>
</p>
<ol><li><a href="#TOC-What-s-in-the-source-"><b>1</b>
What's in the source?</a>
</li>
<li><a href="#TOC-Setting-up-your-machine"><b>2</b>
Setting up your machine</a>
<ol><li><a href="#TOC-Linux"><b>2.1</b>
Linux</a>
<ol><li><a href="#TOC-Ubuntu-Linux-32-bit-x86-"><b>2.1.1</b>
Ubuntu Linux (32-bit x86)</a>
</li>
<li><a href="#TOC-Ubuntu-Linux-64-bit-x86-"><b>2.1.2</b>
Ubuntu Linux (64-bit x86)</a>
</li>
<li><a href="#TOC-Running-Linux-in-a-virtual-machine"><b>2.1.3</b>
Running Linux in a virtual machine</a>
</li>
<li><a href="#TOC-Other-Linux"><b>2.1.4</b>
Other Linux</a>
</li>
</ol>
</li>
<li><a href="#TOC-Mac-OS"><b>2.2</b>
Mac OS</a>
</li>
</ol>
</li>
<li><a href="#TOC-Installing-Repo"><b>3</b>
Installing Repo</a>
</li>
<li><a href="#TOC-Initializing-a-Repo-client"><b>4</b>
Initializing a Repo client</a>
</li>
<li><a href="#TOC-Getting-the-files"><b>5</b>
Getting the files</a>
</li>
<li><a href="#TOC-Verifying-Git-Tags"><b>6</b>
Verifying Git Tags</a>
</li>
<li><a href="#TOC-Building-the-code"><b>7</b>
Building the code</a>
</li>
<li><a href="#TOC-Using-an-IDE"><b>8</b>
Using an IDE</a>
</li>
<li><a href="#TOC-Troubleshooting"><b>9</b>
Troubleshooting</a>
</li>
<li><a href="#TOC-What-s-next-"><b>10</b>
What's next?</a>
</li>
</ol>
</div>
</div>
</div>
</div>
</div>
<div><table><tbody><tr><td>For information about current problems and fixes, see <a href="http://source.android.com/known-issues">Known issues</a>
.</td>
</tr>
</tbody>
</table>
</div>
<div><br>This document describes how to set up your local work environment, how to use Repo to get the Android files, and how to build the files on your machine.<br><br>Related reading:<br></div>
<ul><li>For an overview of the entire code-review and code-update process, see <a href="http://source.android.com/submit-patches/workflow">Workflow</a>
<ul><li>For an overview of the entire code-review and code-update process, see
<a href="{@docRoot}source/life-of-a-patch.html">Life of a Patch</a>
.</li>
<li>For reference details about Repo, see <a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
<li>For reference details about Repo, see <a href="{@docRoot}source/git-repo.html">Using Repo and Git</a>
.<br></li>
</ul>
<h2>
What's in the source?</h2>
<div>For a description of all the projects that make up the Android source code, see <a href="http://source.android.com/projects">Project layout</a>
. To see snapshots and histories of the files available in the public Android repositories, visit the <a href="http://android.git.kernel.org/">GitWeb</a>
<div>To see snapshots and histories of the files available in the public Android repositories, visit the <a href="http://android.git.kernel.org/">GitWeb</a>
web interface.</div>
<div></div>
<div>The source is approximentely 2.1GB in size.You will need 6GB free to complete the build.<br><br></div>
@@ -241,7 +174,9 @@ file:<br># set the number of open files to be 1024<br>ulimit -S -n 1024</li>
<div><br></div>
<h2>
Installing Repo <br></h2>
<div><p>Repo is a tool that makes it easier to work with Git in the context of Android. For more information about Repo, see <a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
<div><p>Repo is a tool that makes it easier to work with Git in the context of
Android. For more information about Repo, see <a
href="{@docRoot}source/git-repo.html">Using Repo and Git</a>
.<br></p>
To install, initialize, and configure Repo, follow these steps:<br><br></div>
<ol><li><span>Make sure you have a~/bindirectory in your home directory, and check to be sure that this bin directory is in your path:</span>
@@ -304,10 +239,10 @@ Getting the files</h2>
<div><span><span>To pull down files to your working directory from the repositories as specified in the default manifest, run</span>
<br><br>$ repo sync <i><br></i>
<br><span>For more aboutrepo syncand other Repo commands, see</span>
<a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
<a href="{@docRoot}source/git-repo.html">Using Repo and Git</a>
<span>.</span>
<br><br><span>The Android source files will be located in your working directory under their <a href="http://source.android.com/projects">project</a>
names.</span>
<br><br><span>The Android source files will be located in your working
directory under their project names.</span>
</span>
<br></div>
<span><h2>
@@ -335,7 +270,7 @@ Building the code</h2>
<p>$ export ANDROID_JAVA_HOME=$JAVA_HOME</p>
<h2>
Using an IDE</h2>
<ul><li><a href="http://source.android.com/using-eclipse">Using Eclipse</a>
<ul><li><a href="{@docRoot}source/using-eclipse.html">Using Eclipse</a>
for Android platform development <br></li>
</ul>
<h2>
@@ -357,9 +292,10 @@ What's next?</h2>
</span>
<span>To learn about reporting an issue and searching previously reported issues,</span>
<span>see</span>
<a href="http://source.android.com/report-bugs">Report bugs</a>
<a href="{@docRoot}source/report-bugs.html">Report bugs</a>
<span>.</span>
<span>For information about editing the files and uploading changes to the code-review server, see <a href="http://source.android.com/submit-patches">Contribute</a>
<span>For information about editing the files and uploading changes to the
code-review server, see <a href="{@docRoot}source/submit-patches.html">Contribute</a>
.</span>
</div>
</div>

95
pdk/docs/source/git-repo.jd
View File

@@ -1,99 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Using Repo and Git
doc.type=source
@jd:body
<h3><b>Using Repo and Git</b>
</h3>
<div><div><div><div><div><div><p><b>Contents</b>
</p>
<ol><li><a href="#TOC-About-Git"><b>1</b>
About Git</a>
<ol><li><a href="#TOC-Why-Git-"><b>1.1</b>
Why Git?</a>
</li>
<li><a href="#TOC-Already-a-Git-user-"><b>1.2</b>
Already a Git user?</a>
</li>
</ol>
</li>
<li><a href="#TOC-Task-reference"><b>2</b>
Task reference</a>
<ol><li><a href="#TOC-Installing-Repo"><b>2.1</b>
Installing Repo</a>
</li>
<li><a href="#TOC-Synchronizing-your-client"><b>2.2</b>
Synchronizing your client</a>
</li>
<li><a href="#TOC-Why-use-topic-branches-"><b>2.3</b>
Why use topic branches?</a>
</li>
<li><a href="#TOC-Creating-topic-branches"><b>2.4</b>
Creating topic branches</a>
</li>
<li><a href="#TOC-Using-topic-branches"><b>2.5</b>
Using topic branches</a>
</li>
<li><a href="#TOC-Viewing-client-status"><b>2.6</b>
Viewing client status</a>
</li>
<li><a href="#TOC-Recovering-sync-conflicts"><b>2.7</b>
Recovering sync conflicts</a>
</li>
<li><a href="#TOC-Cleaning-up-your-client-files"><b>2.8</b>
Cleaning up your client files</a>
</li>
<li><a href="#TOC-Deleting-a-client"><b>2.9</b>
Deleting a client</a>
</li>
<li><a href="#TOC-Scripting-common-tasks"><b>2.10</b>
Scripting common tasks</a>
</li>
</ol>
</li>
<li><a href="#TOC-Repo-command-reference"><b>3</b>
Repo command reference</a>
<ol><li><a href="#TOC-init"><b>3.1</b>
init</a>
</li>
<li><a href="#TOC-sync"><b>3.2</b>
sync</a>
</li>
<li><a href="#TOC-upload"><b>3.3</b>
upload</a>
</li>
<li><a href="#TOC-diff"><b>3.4</b>
diff</a>
</li>
<li><a href="#TOC-download"><b>3.5</b>
download</a>
</li>
<li><a href="#TOC-forall"><b>3.6</b>
forall</a>
</li>
<li><a href="#TOC-help"><b>3.7</b>
help</a>
</li>
<li><a href="#TOC-prune"><b>3.8</b>
prune</a>
</li>
<li><a href="#TOC-start"><b>3.9</b>
start</a>
</li>
<li><a href="#TOC-status"><b>3.10</b>
status</a>
</li>
</ol>
</li>
<li><a href="#TOC-Git-and-Repo-cheatsheet"><b>4</b>
Git and Repo cheatsheet</a>
</li>
<li><a href="#TOC-Terminology"><b>5</b>
Terminology</a>
</li>
</ol>
</div>
</div>
</div>
</div>
<p>To work with the Android code, you will need to use both Git and Repo.<br></p>
<ul><li><i>Git</i>
is an open-source version-control system designed to handle very large projects that are distributed over multiple repositories. In the context of Android, we use Git for local operations such as local branching, commits, diffs, and edits.<br><br></li>

6
pdk/docs/source/index.jd
View File

@@ -19,8 +19,10 @@ read <a href="{@docRoot}source/life-of-a-bug.html">Life of a Bug</a>.</p>
<p>We created Android so that all developers can distribute their applications
to users on an open platform. One of the best ways you can help Android is to
write cool apps that users love!</p>
<p>To get started, visit our sister site, <a
href="http://developer.android.com/">developer.android.com</a>.</p>
<p>To get started, visit <a
href="http://developer.android.com/">developer.android.com</a>. This site
provides the information and tools you need to write applications for
compatible Android devices, using the SDK.</p>
<h2>Contribute to the Code</h2>
<p>Code is King. We'd love to review any changes you submit, so please check

2
pdk/docs/source/licenses.jd
View File

@@ -24,7 +24,7 @@ only on their own behalf) of ideas, code, or documentation to the Android Open
Source Project will be required to complete, sign, and submit an <a
href="{@docRoot}source/cla-individual.html">Individual
Contributor License Grant</a>. The grant can be executed online through the <a
href="http://review.source.android.com/Gerrit#settings,agreements">code review
href="https://review.source.android.com/#settings,agreements">code review
tool</a>. The agreement clearly defines the terms under which intellectual
property has been contributed to the Android Open Source Project.This license
is for your protection as a contributor as well as the protection of the

10
pdk/docs/source/life-of-a-patch.jd
View File

@@ -1,5 +1,11 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Life of a Patch
doc.type=source
@jd:body
<h2>Workflow</h2>
<p>The Android Open Source Project (AOSP) uses a web-based code review tool
known as "gerrit". The image below is a flowchart that details what happens to
a patch, once it's been written. Though it may appear complex, the majority of
the steps below are performed in the web application.</p>
<p>For full instructions on how to get set up to use gerrit and git, please
see <a href="{@docRoot}source/submit-patches.html">the Submitting Patches
page</a>.</p>
<img src="{@docRoot}images/workflow-0.png"/>

11
pdk/docs/source/overview-1.0.jd
View File

@@ -1,11 +1,10 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Android 1.0 Features
doc.type=source
@jd:body
<h3><b>Release features - Android 1.0</b>
</h3>
<div><div><div><div>This page provides a high-level overview of Android 1.0 features. For a list of all the projects that make up the Android 1.0 source code, see<a href="http://source.android.com/projects">Project layout</a>
. To see the code itself, you can either use the<a href="http://git.source.android.com/">GitWeb</a>
interface to view snapshots of the files, or you can<a href="http://source.android.com/download">download</a>
<div><div><div><div>This page provides a high-level overview of Android 1.0
features. To see the code itself, you can either use the <a href="http://android.git.kernel.org/">GitWeb</a>
interface to view snapshots of the files, or you can <a
href="{@docRoot}source/download.html">download</a>
the source code onto your local machine.<br><br><b>Applications</b>
<br><br>The Android platform comes with a variety of applications written using the Java programming language:<br><ul><li><i>Home</i>
displays applications, widgets, and shortcuts. It also supports customizable wall paper.

10
pdk/docs/source/overview-1.5.jd
View File

@@ -1,12 +1,14 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Android 1.5 Features
doc.type=source
@jd:body
<h3><b>Release features - Android 1.5</b>
</h3>
<div><div><div><div><b>Previous release highlights</b>
:<a href="http://source.android.com/release-features---android-1-0">Android 1.0</a>
<br><br>This page provides a high-level overview of the new features added to Android 1.5. To see the code itself, you can either use the<a href="http://git.source.android.com/">GitWeb</a>
interface to view snapshots of the files, or you can<a href="http://source.android.com/download">download</a>
:<a href="{@docRoot}source/overview-1.0.html">Android 1.0</a>
<br><br>This page provides a high-level overview of the new features added to
Android 1.5. To see the code itself, you can either use the<a href="http://android.git.kernel.org/">GitWeb</a>
interface to view snapshots of the files, or you can<a
href="{@docRoot}source/download.html">download</a>
the source code onto your local machine. You can use<i>repo init -u</i>
git://android.git.kernel.org/platform/manifest.git<i>-b android-1.5</i>
to download the source code for Android 1.5.<br><br><b>User interface refinements:</b>

4
pdk/docs/source/overview.jd
View File

@@ -3,9 +3,9 @@ doc.type=source
@jd:body
<p>This page provides a high-level overview of the new features added to
Android 1.6. To see the code itself, you can either use the <a
href="http://git.source.android.com/">GitWeb</a>
href="http://android.git.kernel.org/">GitWeb</a>
interface to view snapshots of the files, or you can <a
href="http://source.android.com/download/idex.html">download</a>
href="{@docRoot}source/download.html">download</a>
the source code onto your local machine. You can use <code>repo init -u
git://android.git.kernel.org/platform/manifest.git -b android-1.6</code>
to download the source code for Android 1.6.</p>

8
pdk/docs/source/roles.jd
View File

@@ -13,14 +13,6 @@ questions, contribute patches, report bugs, look at submitted patches, and use
the tools. To get started with the Android code, see <a
href="{@docRoot}source/index.html">Get Involved</a>.</p>
<h2>AOSP Member</h2>
<p>"AOSP Member" is a somewhat loose term, but generally refers to
those organizations who are key contributors to Android, and who are managing
the product requirements process and core engineering. You can think of this
group as the Android "core team" responsible for Android's overall success in
the marketplace. One of the most prominent AOSP members is Google.</p>
<p/>
<h2>Contributor</h2>
<p>A "Contributor" is anyone making contributions to the AOSP source code,
including both employees or other affiliates of an AOSP Member, as well as

1
pdk/docs/source/source_toc.cs
View File

@@ -25,6 +25,7 @@ function nothing() {}
<li><a href="<?cs var:toroot ?>source/life-of-a-patch.html">Life of a Patch</a></li>
<li><a href="<?cs var:toroot ?>source/submit-patches.html">Submitting Patches</a></li>
<li><a href="<?cs var:toroot ?>source/report-bugs.html">Reporting Bugs</a></li>
<li><a href="<?cs var:toroot ?>source/code-lines.html">Branches &amp; Releases</a></li>
</ul>
</ul>

130
pdk/docs/source/submit-patches.jd
View File

@@ -1,106 +1,29 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Android Contributors' Workflow
doc.type=source
@jd:body
<h3><span><b>Contribute</b>
</span>
</h3>
<div><a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
<div><div><div><div><div><div><p><b>Contents</b>
</p>
<ol><li><a href="#TOC-Prerequisites"><b>1</b>
Prerequisites</a>
</li>
<li><a href="#TOC-Working-with-the-code"><b>2</b>
Working with the code</a>
<ol><li><a href="#TOC-Starting-a-topic-branch"><b>2.1</b>
Starting a topic branch</a>
</li>
<li><a href="#TOC-Editing-the-files"><b>2.2</b>
Editing the files</a>
</li>
<li><a href="#TOC-Staging-changes"><b>2.3</b>
Staging changes</a>
</li>
<li><a href="#TOC-Using-repo-status"><b>2.4</b>
Using repo status</a>
</li>
<li><a href="#TOC-Using-git-diff"><b>2.5</b>
Using git diff</a>
</li>
<li><a href="#TOC-Committing-changes"><b>2.6</b>
Committing changes</a>
</li>
<li><a href="#TOC-Committing-changes-during-code-revi"><b>2.7</b>
Committing changes during code review</a>
</li>
<li><a href="#TOC-Editing-uploaded-changes"><b>2.8</b>
Editing uploaded changes</a>
</li>
<li><a href="#TOC-Uploading-changes-to-Gerrit"><b>2.9</b>
Uploading changes to Gerrit</a>
</li>
<li><a href="#TOC-Summary-example"><b>2.10</b>
Summary example</a>
</li>
<li><a href="#TOC-Downloading-changes-from-Gerrit"><b>2.11</b>
Downloading changes from Gerrit</a>
</li>
</ol>
</li>
<li><a href="#TOC-Using-the-Gerrit-code-review-tool"><b>3</b>
Using the Gerrit code-review tool</a>
<ol><li><a href="#TOC-Viewing-the-status-of-uploaded-chan"><b>3.1</b>
Viewing the status of uploaded changes</a>
</li>
<li><a href="#TOC-Reviewing-a-change"><b>3.2</b>
Reviewing a change</a>
</li>
<li><a href="#TOC-Verifying-a-change"><b>3.3</b>
Verifying a change</a>
</li>
<li><a href="#TOC-Viewing-diffs-and-comments"><b>3.4</b>
Viewing diffs and comments</a>
</li>
<li><a href="#TOC-Adding-comments"><b>3.5</b>
Adding comments</a>
</li>
<li><a href="#TOC-After-a-submission-is-approved"><b>3.6</b>
After a submission is approved</a>
</li>
<li><a href="#TOC-How-do-I-become-a-Verifier-or-Appro"><b>3.7</b>
How do I become a Verifier or Approver?</a>
</li>
</ol>
</li>
<li><a href="#TOC-Using-GitWeb-to-track-patch-histori"><b>4</b>
Using GitWeb to track patch histories</a>
</li>
</ol>
</div>
</div>
</div>
</div>
<table><tbody><tr><td>For information about current problems and fixes, see<a href="http://source.android.com/known-issues">Known issues</a>
.</td>
</tr>
</tbody>
</table>
<br>This page describes how to record changes to the Android files on your local client, upload those changes to the code-review server, and use Gerrit to track changes.<br><h2>
Prerequisites</h2>
Before you follow the instructions on this page, you will need to set up your local working environment and get the Android source files. For instructions, see<a href="http://source.android.com/download">Get source</a>
.<br><br>Other recommended reading:<br><ul><li>For an overview of the code contribution and review process, see<a href="http://source.android.com/submit-patches/workflow">Workflow</a>
Before you follow the instructions on this page, you will need to set up your
local working environment and get the Android source files. For instructions,
see <a href="{@docRoot}source/download.html">Get source</a>
.<br><br>Other recommended reading:<br><ul><li>For an overview of the code
contribution and review process, see <a
href="{@docRoot}source/submit-patches.html">Workflow</a>
.</li>
<li>For details about Repo, see<a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
<li>For details about Repo, see <a href="{@docRoot}source/git-repo.html">Using Repo and Git</a>
.<br></li>
<li>For information about the different roles you can play within the Android Open Source community, see<a href="http://source.android.com/project">Project roles</a>
.</li>
<li>If you plan to contribute code to the Android platform, be sure to read about<a href="http://source.android.com/license">contributor licenses</a>
<li>For information about the different roles you can play within the Android
Open Source community, see <a href="{@docRoot}source/roles.html">Project roles</a>
.</li>
<li>If you plan to contribute code to the Android platform, be sure to read
the <a href="{@docRoot}source/licenses.html">AOSP's licensing information</a>.</li>
</ul>
<h2>
Working with the code</h2>
First, download the source into your working directory, as described in<a href="http://source.android.com/download">Get source</a>
.<br><br>To work on a particular change to the code, follow these steps:<br>
First, download the source into your working directory, as described in <a
href="{@docRoot}source/download.html">Get source</a>
. For information about how to choose which branch to use, see <a
href="{@docRoot}source/code-lines.html">Android Code-Lines</a>.<br><br>To work on a particular change to the code, follow these steps:<br>
<div><img src="{@docRoot}images/submit-patches-0.png">
</div>
<ol><li>Use repo start <i>branchname</i>
@@ -117,7 +40,7 @@ to start a new topic branch.</li>
</ol>
You can track your uploaded changes using the Gerrit code-review tool. When it's time to work on the code again, run repo sync, then go back to step 1 above and start another topic branch.<br><br>The steps will not always come in the order shown--for example, you might run git diff at several points in the process.<br><br><h3>
Starting a topic branch</h3>
Start a topic branch called default in your local work environment:<br><br>$ repo start default<br><br>For more about topic branches, see<a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
Start a topic branch called default in your local work environment:<br><br>$ repo start default <br><br>For more about topic branches, see <a href="{@docRoot}source/git-repo.html">Using Repo and Git</a>
.<br><h3>
Editing the files</h3>
You do not need to check files out before working on them. Edit the files using vim, emacs, or any other editor.<br><br><h3>
@@ -125,7 +48,7 @@ Staging changes</h3>
To indicate that every new and modified file in your working directory should be "staged" for inclusion in the next commit, run git add without any arguments. You can also specify files or filetypes. For example, the following command would stage all the new and modified files under the bionic directory and its subdirectories:<br><br>$ git add bionic/*<br><br>Run git help add to see more ways to use git add.<br><br><b>When is git add optional?<br></b>
<br>If you add new files, you must stage them using git add before you run git commit. However, if you are only modifying or deleting files, you can skip git add if you use the -a option with git commit. For more details, see the "Committing changes" section further down.<br><br><h3>
Using repo status <br></h3>
To see the status of the current branch, run<br><br>$ repo status .<br><br>For information about how to interpret the results of repo status, see<a href="http://source.android.com/download/using-repo#TOC-status">Using Repo and Git</a>
To see the status of the current branch, run <br><br>$ repo status .<br><br>For information about how to interpret the results of repo status, see <a href="{@docRoot}source/git-repo.html#TOC-status">Using Repo and Git</a>
.<br><br><h3>
Using git diff</h3>
To see uncommitted changes, cd into the project directory and run <br><br>$ git
@@ -135,8 +58,6 @@ files.<br><div><br><div><img src="{@docRoot}images/submit-patches-1.png">
</div>
<br></div>
<div>If you add the --cached option, git diff will show you the differences between the files in your working directory and the staged files.<br><br></div>
<div><a href="http://source.android.com/submit-patches/git-diff.gif?attredirects=0"><br></a>
</div>
To see every edit that would go into the commit if you were to commit right now, make sure you are in the project directory and then run <br><br>$ git diff --cached <br><br><h3>
Committing changes</h3>
At intervals while you are working, commit your edits by using git commit from within the project directory:<br><span>$ cd ~/mydroid/<i>project-name</i>
@@ -159,7 +80,7 @@ To update an existing change with a new patch set:<br><ol><li>Make sure the upda
to open the change matching editor.</li>
<li>For each commit in the series, enter the Gerrit change Id inside the brackets.</li>
</ol>
For more details, see<a href="http://source.android.com/download/using-repo#TOC-upload">Using Repo and Git</a>
For more details, see <a href="{@docRoot}source/git-repo.html#TOC-upload">Using Repo and Git</a>
.<br><h3>
Uploading changes to Gerrit</h3>
To upload your committed changes to the review server:<br><ol><li>Complete the appropriate <a href="https://review.source.android.com/#settings,new-agreement">Contributor Agreement</a>
@@ -170,7 +91,7 @@ and upload your<a href="https://review.source.android.com/#settings,ssh-keys">pu
<li>Update to the latest revisions:<span><br></span>
<span>$</span>
<span>repo sync</span>
<br><br>For information about how to handle sync conflicts and how Repo synchronization works, see<a href="http://source.android.com/download/using-repo#TOC-sync">Using Repo and Git</a>
<br><br>For information about how to handle sync conflicts and how Repo synchronization works, see <a href="{@docRoot}source/git-repo.html#TOC-sync">Using Repo and Git</a>
.<br><br></li>
<li>Run repo upload to examine the list of all available changes and select which topic branches will be uploaded to the review server:<br><span>$</span>
<span>repo upload</span>
@@ -179,7 +100,7 @@ and upload your<a href="https://review.source.android.com/#settings,ssh-keys">pu
After a change is uploaded successfully:<br><ul><li>Repo will give you a URL where you can view your submission.</li>
<li>The code-review system will automatically notify the project owner about your submission.</li>
</ul>
For information about specifying particular projects with repo sync and repo upload, see<a href="http://source.android.com/download/using-repo">Using Repo and Git</a>
For information about specifying particular projects with repo sync and repo upload, see <a href="{@docRoot}source/git-repo.html">Using Repo and Git</a>
.<br><br><h3>
Summary example <br></h3>
Here is a simple example that shows how you might work with the bionic/Android.mk file:<br><br>$ cd ~/mydroid/bionic <br>$ repo start default <br>$ vi Android.mk <br><i>...edit and save the file...</i>
@@ -189,7 +110,7 @@ Here is a simple example that shows how you might work with the bionic/Android.m
Downloading changes from Gerrit</h3>
To download a specific change from Gerrit, run <br><br>$ repo download <i>target change</i>
<br><br>where target is the local directory into which the change should be downloaded andchange is the change number as listed in <a href="https://review.source.android.com/">Gerrit</a>
. For more information, see<a href="http://source.android.com/download/using-repo#TOC-download">Using Repo and Git</a>
. For more information, see <a href="{@docRoot}source/git-repo.html#TOC-download">Using Repo and Git</a>
.<br><br><h2>
Using the Gerrit code-review tool <br></h2>
You can open Gerrit by visiting whatever URL is returned to you from the repo upload command, or by visiting <a href="https://review.source.android.com/">https://review.source.android.com</a>
@@ -199,8 +120,7 @@ To check the status of a change that you uploaded, open<a href="https://review.s
, sign in, and click MyChanges.<br><b><br></b>
<h3>
Reviewing a change <br></h3>
If you are assigned to be the Approver for a change, you need to determine the following:<br><ul><li>Does this change fit within this project's stated purpose? (See<a href="http://source.android.com/projects">Project layout</a>
.)<br></li>
If you are assigned to be the Approver for a change, you need to determine the following:<br><ul><li>Does this change fit within this project's stated purpose?<br></li>
<li>Is this change valid within the project's existing architecture?</li>
<li>Does this change introduce design flaws that will cause problems in the future?</li>
<li>Does this change following the best practices that have been established for this project?</li>
@@ -222,7 +142,9 @@ Anyone in the community can use Gerrit to add inline comments to code submission
After a submission is approved</h3>
After a submission makes it through the review and verification process, Gerrit automatically merges the change into the public repository. The change will now be visible in gitweb, and others users will be able to run repo sync to pull the update into their local client.<br><br><h3>
How do I become a Verifier or Approver?</h3>
In short, contribute high-quality code to one or more of the Android projects. For details about the different roles in the Android Open Source community and who plays them, see<a href="http://source.android.com/project">Project roles</a>
In short, contribute high-quality code to one or more of the Android projects.
For details about the different roles in the Android Open Source community and
who plays them, see <a href="{@docRoot}source/roles.html">Project roles</a>
.<br><br><h2>
Using GitWeb to track patch histories</h2>
To view snapshots of the files that are in the public Android repositories and view file histories, use the <a href="http://android.git.kernel.org/">Android instance of GitWeb</a>

4
pdk/docs/source/using-eclipse.jd
View File

@@ -1,8 +1,6 @@
page.title=Android Compatibility - Compatibility Test Suite
page.title=Using Eclipse
doc.type=source
@jd:body
<h3><b>Using Eclipse</b>
</h3>
<div><h2><a>About this Document</a>
</h2>
<p>This document will help you set up the Eclipse IDE for Android platform development.