Gitiles
Code Review Sign In
review.blissroms.org / platform_frameworks_support / d81c9b315386f3e60cc9084abd4f89f3e47fa4f0
commitd81c9b315386f3e60cc9084abd4f89f3e47fa4f0[log] [tgz]
authorDoris Liu <tianliu@google.com>Wed Mar 15 19:04:13 2017 +0000
committerandroid-build-merger <android-build-merger@google.com>Wed Mar 15 19:04:13 2017 +0000
tree774c1ed40f7b8a324d341dfa56abea84a8352a34
parent208f3a664f9df7b8a7edd4bbb12b3cc5f8cf0c3b [diff]
parent15adec872b319cb0309f76537eb1141e07d8e15a [diff]
Merge "Add basic code samples to class level description" into nyc-support-25.3-dev am: 00dcd1d709
am: 15adec872b

Change-Id: I52b99c4fd7bfae20a9b1b0bbc27ef8e302502e98
tree: 774c1ed40f7b8a324d341dfa56abea84a8352a34
  1. .idea/
  2. annotations/
  3. api/
  4. buildSrc/
  5. compat/
  6. core-ui/
  7. core-utils/
  8. customtabs/
  9. design/
  10. development/
  11. dynamic-animation/
  12. emoji/
  13. exifinterface/
  14. fragment/
  15. frameworks/
  16. gradle/
  17. graphics/
  18. instantvideo/
  19. media-compat/
  20. percent/
  21. recommendation/
  22. samples/
  23. scripts/
  24. testutils/
  25. transition/
  26. tv-provider/
  27. v13/
  28. v14/
  29. v17/
  30. v4/
  31. v7/
  32. wearable/
  33. .gitignore
  34. Android.mk
  35. build.gradle
  36. CleanSpec.mk
  37. droiddoc.mk
  38. gradle.properties
  39. gradlew
  40. pathmap.mk
  41. PREUPLOAD.cfg
  42. README.md
  43. settings.gradle
README.md

AOSP Support Library Contribution Guide

Accepted Types of Contributions

  • Bug fixes (needs a corresponding bug report in b.android.com)
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests

We are not currently accepting new modules, features, or behavior changes.

Checking Out the Code

NOTE: You will need to use Linux or Mac OS. Building under Windows is not currently supported.

Follow the “Downloading the Source” guide to install and set up repo tool, but instead of running the listed repo commands to initialize the repository, run the folowing:

repo init -u https://android.googlesource.com/platform/manifest -b ub-supportlib-master

Now your repository is set to pull only what you need for building and running support library. Download the code (and grab a coffee while we pull down 7GB):

repo sync -j8 -c

You will use this command to sync your checkout in the future - it’s similar to git fetch

Using Android Studio

Open path/to/checkout/frameworks/support/ in Android Studio. Now you're ready edit, run, and test!

If you get “Unregistered VCS root detected” click “Add root” to enable git integration for Android Studio.

If you see any warnings (red underlines) run Build > Clean Project.

Optional - Full Build

You can do most of your work from Android Studio, however you can also build the full support library from command line:

cd path/to/checkout/frameworks/support/
./gradlew createArchive

Running Tests

Single Test Class or Method

  1. Open the desired test file in Android Studio.
  2. Right-click on a test class or @Test method name and select Run FooBarTest

Full Test Package

  1. In the project side panel open the desired module.
  2. Find the directory with the tests
  3. Right-click on the directory and select Run android.support.foobar

Running Sample Apps

Support library has a set of Android applications that exercise support library code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.

These applications are named support-*-demos (e.g. support-4v-demos or support-leanback-demos. You can run them by clicking Run > Run ... and choosing the desired application.

Making a change

cd path/to/checkout/frameworks/support/
repo start my_branch_name .
(make needed modifications)
git commit -a
repo upload --current-branch .

If you see the following prompt, choose always:

Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing)