From d65703a80bb49920245c569cf416ce193ee5668f Mon Sep 17 00:00:00 2001 From: wnwen Date: Thu, 24 Nov 2016 10:47:31 -0800 Subject: [PATCH] Android: Update docs for auto import. Android studio requires additional configuration to enable automatic imports on the fly. Also fix some markdown formatting, 4-space tabs necessary for sublists. BUG=667858 Review-Url: https://codereview.chromium.org/2530903003 Cr-Commit-Position: refs/heads/master@{#434370} --- docs/android_studio.md | 57 ++++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/docs/android_studio.md b/docs/android_studio.md index 95258865a3fd55..08d6b4e3f45e2b 100644 --- a/docs/android_studio.md +++ b/docs/android_studio.md @@ -23,18 +23,18 @@ build/android/gradle/generate_gradle.py --output-directory out-gn/Debug --target For first-time Android Studio users: - * Avoid running the setup wizard. +* Avoid running the setup wizard. * The wizard will force you to download unwanted SDK components to `//third_party/android_tools`. * To skip it, select "Cancel" when it comes up. To import the project: - * Use "Import Project", and select the directory containing the generated project. +* Use "Import Project", and select the directory containing the generated project. You need to re-run `generate_gradle.py` whenever `BUILD.gn` files change. - * After regenerating, Android Studio should prompt you to "Sync". If it doesn't, use: - * Help -> Find Action -> Sync Project with Gradle Files +* After regenerating, Android Studio should prompt you to "Sync". If it doesn't, use: + * Help -> Find Action -> "Sync Project with Gradle Files" ## How it Works @@ -67,24 +67,27 @@ includes `R.java`). ## Android Studio Tips - * Configuration instructions can be found [here](http://tools.android.com/tech-docs/configuration). One suggestions: +* Configuration instructions can be found [here](http://tools.android.com/tech-docs/configuration). One suggestions: * Launch it with more RAM: `STUDIO_VM_OPTIONS=-Xmx2048m /opt/android-studio-stable/bin/studio-launcher.sh` - * If you ever need to reset it: `rm -r ~/.AndroidStudio*/` - * Import Android style settings: - * Help -> Find Action -> Code Style -> Java -> Manage -> Import - * Select `third_party/android_platform/development/ide/intellij/codestyles/AndroidStyle.xml` +* If you ever need to reset it: `rm -r ~/.AndroidStudio*/` +* Import Android style settings: + * Help -> Find Action -> "Code Style" (settings) -> Java -> Manage -> Import + * Select `third_party/android_platform/development/ide/intellij/codestyles/AndroidStyle.xml` +* Turn on automatic import: + * Help -> Find Action -> "Auto Import" + * Tick all the boxes under "Java" and change the dropdown to "All". ### Useful Shortcuts - * `Shift - Shift`: Search to open file or perform IDE action - * `Ctrl + N`: Jump to class - * `Ctrl + Shift + T`: Jump to test - * `Ctrl + Shift + N`: Jump to file - * `Ctrl + F12`: Jump to method - * `Ctrl + G`: Jump to line - * `Shift + F6`: Rename variable - * `Ctrl + Alt + O`: Organize imports - * `Alt + Enter`: Quick Fix (use on underlined errors) +* `Shift - Shift`: Search to open file or perform IDE action +* `Ctrl + N`: Jump to class +* `Ctrl + Shift + T`: Jump to test +* `Ctrl + Shift + N`: Jump to file +* `Ctrl + F12`: Jump to method +* `Ctrl + G`: Jump to line +* `Shift + F6`: Rename variable +* `Ctrl + Alt + O`: Organize imports +* `Alt + Enter`: Quick Fix (use on underlined errors) ### Building from the Command Line @@ -97,21 +100,21 @@ This wrapper can also be used to invoke gradle commands. The resulting artifacts are not terribly useful. They are missing assets, resources, native libraries, etc. - * Use a [gradle daemon](https://docs.gradle.org/2.14.1/userguide/gradle_daemon.html) to speed up builds: +* Use a [gradle daemon](https://docs.gradle.org/2.14.1/userguide/gradle_daemon.html) to speed up builds: * Add the line `org.gradle.daemon=true` to `~/.gradle/gradle.properties`, creating it if necessary. ## Status (as of Sept 21, 2016) ### What works - * Tested with Android Studio v2.2. - * Basic Java editing and compiling works. +* Tested with Android Studio v2.2. +* Basic Java editing and compiling works. ### What doesn't work (yet) ([crbug](https://bugs.chromium.org/p/chromium/issues/detail?id=620034)) - * Better support for instrumentation tests (they are treated as non-test .apks right now) - * Make gradle aware of resources and assets - * Make gradle aware of native code via pointing it at the location of our .so - * Add a mode in which gradle is responsible for generating `R.java` - * Add support for native code editing - * Make the "Make Project" button work correctly +* Better support for instrumentation tests (they are treated as non-test .apks right now) +* Make gradle aware of resources and assets +* Make gradle aware of native code via pointing it at the location of our .so +* Add a mode in which gradle is responsible for generating `R.java` +* Add support for native code editing +* Make the "Make Project" button work correctly