From a6db53f077f6d1e74e97b878efd5f6f0d6623f95 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Queru Date: Tue, 25 Jan 2011 15:16:28 -0800 Subject: [PATCH] Current files for source.android.com This matches the current state of the live site. Change-Id: If209bc337d31cf8669e2afb78c9b52e5bbe3cdac --- pdk/docs/about/index.jd | 8 +- pdk/docs/about/philosophy.jd | 35 +- pdk/docs/community/groups-charter.jd | 66 +- pdk/docs/community/index.jd | 54 +- pdk/docs/compatibility/2.1/versions.jd | 19 + pdk/docs/compatibility/2.2/versions.jd | 20 + pdk/docs/compatibility/2.3/versions.jd | 20 + pdk/docs/compatibility/android-1.6-cdd.pdf | Bin 0 -> 218712 bytes pdk/docs/compatibility/android-2.1-cdd.pdf | Bin 0 -> 254947 bytes pdk/docs/compatibility/android-2.2-cdd.pdf | 4080 +++++++++++++ pdk/docs/compatibility/android-2.3-cdd.pdf | 5223 +++++++++++++++++ .../compatibility/android-cts-manual-r4.pdf | Bin 0 -> 335257 bytes pdk/docs/compatibility/compatibility_toc.cs | 5 +- pdk/docs/compatibility/contact-us.jd | 13 +- pdk/docs/compatibility/cts-development.jd | 130 + pdk/docs/compatibility/cts-intro.jd | 10 +- pdk/docs/compatibility/downloads.jd | 60 + pdk/docs/compatibility/index.jd | 57 +- pdk/docs/compatibility/overview.jd | 17 +- pdk/docs/downloads/downloads_toc.cs | 21 - pdk/docs/downloads/index.jd | 44 - pdk/docs/faqs.jd | 56 +- pdk/docs/images/code-lines.png | Bin 238643 -> 347510 bytes pdk/docs/index.jd | 65 +- pdk/docs/porting/bluetooth.jd | 84 +- pdk/docs/porting/debugging_native.jd | 8 +- pdk/docs/porting/instrumentation_testing.jd | 6 +- pdk/docs/source/building-dream.jd | 19 +- pdk/docs/source/code-lines.jd | 41 +- pdk/docs/source/code-style.jd | 993 ++-- pdk/docs/source/git-repo.jd | 10 +- pdk/docs/source/index.jd | 10 +- pdk/docs/source/licenses.jd | 25 +- pdk/docs/source/life-of-a-bug.jd | 6 +- pdk/docs/source/overview-1.0.jd | 157 - pdk/docs/source/overview-1.5.jd | 198 - pdk/docs/source/overview.jd | 125 +- pdk/docs/source/report-bugs.jd | 2 +- pdk/docs/source/roles.jd | 26 +- pdk/docs/source/submit-patches.jd | 33 +- pdk/docs/source/using-eclipse.jd | 61 - 41 files changed, 10569 insertions(+), 1238 deletions(-) create mode 100644 pdk/docs/compatibility/2.1/versions.jd create mode 100644 pdk/docs/compatibility/2.2/versions.jd create mode 100644 pdk/docs/compatibility/2.3/versions.jd create mode 100644 pdk/docs/compatibility/android-1.6-cdd.pdf create mode 100644 pdk/docs/compatibility/android-2.1-cdd.pdf create mode 100644 pdk/docs/compatibility/android-2.2-cdd.pdf create mode 100644 pdk/docs/compatibility/android-2.3-cdd.pdf create mode 100644 pdk/docs/compatibility/android-cts-manual-r4.pdf create mode 100644 pdk/docs/compatibility/cts-development.jd create mode 100644 pdk/docs/compatibility/downloads.jd delete mode 100644 pdk/docs/downloads/downloads_toc.cs delete mode 100644 pdk/docs/downloads/index.jd delete mode 100644 pdk/docs/source/overview-1.0.jd delete mode 100644 pdk/docs/source/overview-1.5.jd diff --git a/pdk/docs/about/index.jd b/pdk/docs/about/index.jd index 2f98b6540..43d2a8d16 100644 --- a/pdk/docs/about/index.jd +++ b/pdk/docs/about/index.jd @@ -3,10 +3,10 @@ doc.type=about doc.hidenav=true @jd:body

Android is an open-source software stack created for mobile phones and -other devices. The Android Open Source Project (AOSP) is tasked with the -maintenance and further development of Android. Many device manufacturers have -brought to market devices running Android, and they are readibly available -around the world.

+other devices. The Android Open Source Project (AOSP), led by Google, is +tasked with the maintenance and further development of Android. Many device +manufacturers have brought to market devices running Android, and they are +readibly available around the world.

Our primary purpose is to build an excellent software platform for everyday users. A number of companies have committed many engineers to achieve this goal, and the result is a full production quality consumer product whose diff --git a/pdk/docs/about/philosophy.jd b/pdk/docs/about/philosophy.jd index 1aa1ccf32..1562e42d0 100644 --- a/pdk/docs/about/philosophy.jd +++ b/pdk/docs/about/philosophy.jd @@ -2,7 +2,7 @@ page.title=Philosophy and Goals doc.type=about doc.hidenav=true @jd:body -

Android is an open-source software stack for mobile phones and similar +

Android is an open-source software stack for mobile phones and other devices.

Origin and Goal

Android was originated by a group of companies known as the Open Handset @@ -16,12 +16,11 @@ available for carriers, OEMs, and developers to use to make their innovative ideas a reality. We wanted to make sure that there was no central point of failure, where one industry player could restrict or control the innovations of any other. The solution we chose was an open and open-source platform.

-

But the ultimate goal, of course, is to improve the mobile experience for -real users by facilitating innovation. Accordingly, the primary goal of the -AOSP is to make sure Android is a success as an end user product.

+

The goal of the Android Open Source Project is to create a successful +real-world product that improves the mobile experience for end users.

Governance Philosophy

The companies that have invested in Android have done so on its merits, -because we collectively believe that an open platform is necessary. Android is +because we believe that an open platform is necessary. Android is intentionally and explicitly an open-source -- as opposed to free software -- effort: a group of organizations with shared needs has pooled resources to collaborate on a single implementation of a shared product. @@ -34,20 +33,19 @@ compatible", and what is required of device builders to achieve that status. Anyone can (and will!) use the Android source code for any purpose, and we welcome all such uses. However, in order to take part in the shared ecosystem of applications that we are building around Android, device builders -can take advantage of the Compatibility Program.

+must participate in the Compatibility Program.

Though Android consists of multiple sub-projects, this is strictly a project-management technique. We view and manage Android as a single, holistic software product, not a "distribution", specification, or collection -of replaceable parts. Conceptually, our notion is that device builders port +of replaceable parts. Our intent is that device builders port Android to a device; they don't implement a specification or curate a distribution.

How We Work

We know that quality does not come without hard work. Along with many partners, Google has contributed full-time engineers, product managers, UI designers, Quality Assurance, and all the other roles required to bring -modern devices to market. We integrate the open source administration and +modern devices to market. We roll the open source administration and maintenance into the larger product development cycle.

-

In a nutshell:

-

To meet our goals, Android needs to achieve widespread, compatible -adoption. We believe that the best way to accomplish that is to make sure that -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.

diff --git a/pdk/docs/community/groups-charter.jd b/pdk/docs/community/groups-charter.jd index 6d5b501ed..959917e94 100644 --- a/pdk/docs/community/groups-charter.jd +++ b/pdk/docs/community/groups-charter.jd @@ -1,26 +1,66 @@ page.title=Android Discussion Groups Charter doc.type=community +doc.hidenav=true @jd:body -

-Audience -

-

These discussion groups are intended for developers working with the Android platform. Everyone is welcome to join in, provided you follow our community's policies described below. Our users help each other, and many experts post to these groups, including members of the Open Handset Alliance. +

Audience

+

These discussion groups are intended for developers working with the +Android platform. Everyone is welcome to join in, provided you follow our +community's policies described below. Our users help each other, and many +experts post to these groups, including members of the Open Handset Alliance.

-

No topic is off-limits, provided it relates to Android in some way. However, since these are very busy lists, search the archives before posting your question; you may find your question has already been answered. +

No topic is off-limits, provided it relates to Android in some way. +However, since these are very busy lists, search the archives before posting +your question; you may find your question has already been answered.

-

-Mailing list rules -

-

We love simplicity and hate restrictions, so we keep our policies minimal. The rules below describe what's expected of subscribers to the Android mailing lists. +

Mailing list rules

+

We love simplicity and hate restrictions, so we keep our policies minimal. +The rules below describe what's expected of subscribers to the Android mailing +lists.

-

The most important rule is friendliness. Remember: disrespect and rudeness are not welcome in our community under any circumstances. We don't have a formal policy on dealing with troublemakers, and we hope we never need one.That said, we do pledge to do our best to be fair, and we will always try to warn someone before banning him or her. + +

The most important rule is friendliness. Remember: disrespect and rudeness +are not welcome in our community under any circumstances. We don't have a +formal policy on dealing with troublemakers, and we hope we never need +one.That said, we do pledge to do our best to be fair, and we will always try +to warn someone before banning him or her.

Contacting the moderators diff --git a/pdk/docs/community/index.jd b/pdk/docs/community/index.jd index 6e6f59e52..46adf37ae 100644 --- a/pdk/docs/community/index.jd +++ b/pdk/docs/community/index.jd @@ -1,7 +1,7 @@ -page.title=Community +page.title=Android Community doc.type=community +doc.hidenav=true @jd:body -

Android Community

Welcome to the Android community!

The key to any community is, obviously, communication. Like most projects, Android communicates via mailing lists. Because Android is an extremely large @@ -37,6 +37,14 @@ href="http://developer.android.com/community/index.html">http://developer.androi

Open Source Project discussions

diff --git a/pdk/docs/source/submit-patches.jd b/pdk/docs/source/submit-patches.jd index 2b7bae1e1..9e7d9dfb4 100644 --- a/pdk/docs/source/submit-patches.jd +++ b/pdk/docs/source/submit-patches.jd @@ -1,6 +1,7 @@ page.title=Android Contributors' Workflow doc.type=source @jd:body +

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.

Prerequisites

Before you follow the instructions on this page, you will need to set up your @@ -14,6 +15,9 @@ href="{@docRoot}source/life-of-a-patch.html">Life of a Patch. Open Source community, see Project roles.
  • If you plan to contribute code to the Android platform, be sure to read the AOSP's licensing information.
    • +
  • Note that changes to some of the upstream projects used by Android should be +made directly to that project, as described in +Upstream Projects.

    Working with the code

    @@ -129,8 +133,8 @@ If you are assigned to be the Verifier for a change, you need to do the followin

    Viewing diffs and comments

    -To open the details of the change within Gerrit, click on the "Id number" or "Subject" of a change. To compare the established code with the updated code, click the file name under "Side-by-side diffs."
    • -

    +To open the details of the change within Gerrit, click on the "Id number" or "Subject" of a change. To compare the established code with the updated code, click the file name under "Side-by-side diffs."
    +

    Adding comments

    Anyone in the community can use Gerrit to add inline comments to code submissions. A good comment will be relevant to the line or section of code to which it is attached in Gerrit. It might be a short and constructive suggestion about how a line of code could be improved, or it might be an explanation from the author about why the code makes sense the way it is.

    To add an inline comment, double-click the relevant line of the code and write your comment in the text box that opens. When you click Save, only you can see your comment.

    To publish your comments so that others using Gerrit will be able to see them, click the Publish Comments button. Your comments will be emailed to all relevant parties for this change, including the change owner, the patch set uploader (if different from the owner), and all current reviewers.

    After a submission is approved

    @@ -142,6 +146,27 @@ who plays them, see Project roles .

    Using GitWeb to track patch histories

    To view snapshots of the files that are in the public Android repositories and view file histories, use the Android instance of GitWeb -.
    - +.
    +

    Upstream Projects

    +Android makes use of a number of other open-source projects, such as the Linux +kernel and WebKit, as described in +Branches & Releases. For the +upstream projects detailed below, changes should be made directly upstream. Such +changes will be incorporated into the Android tree as part of the usual process +of pulling these projects. +

    WebKit

    +All changes to the WebKit project at external/webkit should be made +upstream at http://www.webkit.org. The +process begins by filing a WebKit bug. This bug should use Android +for the Platform and OS fields only if the bug is +specific to Android. Bugs are far more likely to receive the reviewers' +attention once a proposed fix is added and tests are included. See +Contributing Code to +WebKit for details. +

    V8

    +All changes to the V8 project at external/v8 should be submitted +upstream at +http://code.google.com/p/v8. See +Contributing to V8 +for details. diff --git a/pdk/docs/source/using-eclipse.jd b/pdk/docs/source/using-eclipse.jd index 56df71377..660de11c8 100644 --- a/pdk/docs/source/using-eclipse.jd +++ b/pdk/docs/source/using-eclipse.jd @@ -95,58 +95,6 @@ Adding apps to the build path

    When you're done, the "source folder" path in the list should look like android/packages/apps/YourAppName /src. Depending on which app(s) you include, you may also need to include othersrc/main/java directories under android/dalvik/libcore. Do this if you find you cannot build with the default set.

    -

    -Eclipse setup to work on developer tools -

    -

    To work on Java developer tools, the principle is the same, except you specify /path/to/tool when using the option "Create project from existing source." -

    -

    Once the project is created, you need to set up the Java Build Path: -

    -
    1. Select the project you just created. -
      2. -
    2. Project Properties -
      3. -
    3. Select "Java Build Path" from the left-hand menu. -
      4. -
    4. Choose the "Source" tab. -
      5. -
    5. Expand the single toolname -/src entry. -
      6. -
    6. Double click the "Excluded: (none)" item. -
      7. -
    7. Add to the excluded (bottom) list: "MakeFile" and "resources/". -
      8. -
    8. Close the dialog. -
      9. -
    9. Back in the "Source" tab, click "Add Folder...", and add toolname -/src/resources. -
      10. -
    10. Click OK. -
      11. -
    -

    -Eclipse setup to work on DDMS

    -

    For DDMS, you will need to make a project for -

    -
    1. development/tools/ddms/libs/ddmlib -
      2. -
    2. development/tools/ddms/libs/ddmuilib -
      3. -
    3. development/tools/ddms/app -
      4. -
    -

    Each project will need to reference the ones before it ("ddmuilib" references "ddmlib", and "app" references both of those). To do this: -

    -
    1. Make sure you have all 3 projects defined. -
      2. -
    2. Right click on a project, "Build Path" "Configure Build Path..." -
      3. -
    3. Choose the "Project" tab. -
      4. -
    4. Click "Add..." and check the required projects. -
      5. -

    Eclipse formatting

    You can import files in development/ide/eclipse to make Eclipse @@ -189,15 +137,6 @@ and "Organize Imports › Import" to import android.importorder. 

    Ctrl-Shift-o = Organize imports 
    Ctrl-Shift-t = load class by name 
    Ctrl-Shift-r = load non-class resource by name 
    Ctrl-1 = quick fix 
    Ctrl-e = Recently viewed files 
    Ctrl-space = auto complete 
    Shift-Alt-r = refactor:rename 
    Shift-Alt-v = refactor:move
    -

    Useful Plugins -

    -

    Eclipse has a plugin architecture that enables third parties to extend the IDE. Here are some plugins that make Eclipse easier to use for writing Android software: -

    - -
    • AnyEdit -- automatically fix whitespace issues when saving files. Can convert tabs to spaces, strip blanks at end-of-line, and ensure the last line of the file has an end-of-line character. -
      • -

    "Eclipse is not working correctly, what should I do?"

    Make sure: