Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(3401)

Unified Diff: docs/android_build_instructions.md

Issue 1880093002: docs: migrate the rest of android build instructions from html to markdown (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: keep lines under 80 chars Created 4 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/android_build_instructions.md
diff --git a/docs/android_build_instructions.md b/docs/android_build_instructions.md
index c377207cab8d7864944d782d0b35038779844ff0..299e5722f2a178656f562ad755cbc867c62374e4 100644
--- a/docs/android_build_instructions.md
+++ b/docs/android_build_instructions.md
@@ -188,3 +188,167 @@ third_party/android_tools/sdk/platform-tools/adb devices
Which prints a list of connected devices. If not connected, try
unplugging and reattaching your device.
+
+### Build the full browser
+
+**Note: When adding new resource files or java files in gyp builds, you
+need to run 'gclient runhooks' again to get them in the build.**
+
+```shell
+ninja -C out/Release chrome_public_apk
+```
+
+And deploy it to your Android device:
+
+```shell
+build/android/adb_install_apk.py out/Release/apks/ChromePublic.apk # For gyp.
+CHROMIUM_OUTPUT_DIR=$gndir build/android/adb_install_apk.py $gndir/apks/ChromePublic.apk # for gn.
+```
+
+The app will appear on the device as "Chromium".
+
+### Build Content shell
+
+Wraps the content module (but not the /chrome embedder). See
+[http://www.chromium.org/developers/content-module](http://www.chromium.org/developers/content-module)
+for details on the content module and content shell.
+
+```shell
+ninja -C out/Release content_shell_apk
+build/android/adb_install_apk.py out/Release/apks/ContentShell.apk
+```
+
+this will build and install an Android apk under
+`out/Release/apks/ContentShell.apk`. For GYP, replace `Release` with `Debug`
+above if you want to generate a Debug app. If you are using GN, substitute the
+name you initially gave to your build directory.
+
+If you use custom out dir instead of standard out/ dir, use
+CHROMIUM_OUT_DIR env.
+
+```shell
+export CHROMIUM_OUT_DIR=out_android
+```
+
+### Build WebView shell
+
+[Android WebView](http://developer.android.com/reference/android/webkit/WebView.html)
+is a system framework component. Since Android KitKat, it is implemented using
+Chromium code (based off the [content module](http://dev.chromium.org/developers/content-module)).
+It is possible to test modifications to WebView using a simple test shell. The
+WebView shell is a view with a URL bar at the top (see [code](https://code.google.com/p/chromium/codesearch#chromium/src/android_webview/test/shell/src/org/chromium/android_webview/test/AwTestContainerView.java))
+and is **independent** of the WebView **implementation in the Android system** (
+the WebView shell is essentially a standalone unbundled app).
+As drawback, the shell runs in non-production rendering mode only.
+
+```shell
+ninja -C out/Release android_webview_apk
+build/android/adb_install_apk.py out/Release/apks/AndroidWebView.apk
+```
+
+If, instead, you want to build the complete Android WebView framework component and test the effect of your chromium changes in other Android app using the WebView, you should follow the [Android AOSP + chromium WebView instructions](http://www.chromium.org/developers/how-tos/build-instructions-android-webview)
+
+### Running
+
+Set [command line flags](https://www.chromium.org/developers/how-tos/run-chromium-with-flags) if necessary.
+
+For Content shell:
+
+```shell
+build/android/adb_run_content_shell http://example.com
+```
+
+For Chrome public:
+
+```shell
+build/android/adb_run_chrome_public http://example.com
+```
+
+For Android WebView shell:
+
+```shell
+build/android/adb_run_android_webview_shell http://example.com
+```
+
+### Logging and debugging
+
+Logging is often the easiest way to understand code flow. In C++ you can print
+log statements using the LOG macro or printf(). In Java, you can print log
+statements using [android.util.Log](http://developer.android.com/reference/android/util/Log.html):
+
+`Log.d("sometag", "Reticulating splines progress = " + progress);`
+
+You can see these log statements using adb logcat:
+
+```shell
+adb logcat...01-14 11:08:53.373 22693 23070 D sometag: Reticulating splines progress = 0.99
+```
+
+You can debug Java or C++ code. To debug C++ code, use one of the
+following commands:
+
+```shell
+build/android/adb_gdb_content_shell
+build/android/adb_gdb_chrome_public
+build/android/adb_gdb_android_webview_shell http://example.com
+```
+
+See [Debugging Chromium on Android](https://www.chromium.org/developers/how-tos/debugging-on-android)
+for more on debugging, including how to debug Java code.
+
+### Testing
+
+For information on running tests, see [android\_test\_instructions.md](https://chromium.googlesource.com/chromium/src/+/master/docs/android_test_instructions.md).
+
+### Faster Edit/Deploy (GN only)
+
+GN's "incremental install" uses reflection and side-loading to speed up the edit
+& deploy cycle (normally < 10 seconds).
+
+* Make sure to set` is_component_build = true `in your GN args
+* All apk targets have \*`_incremental` targets defined (e.g.
+ `chrome_public_apk_incremental`)
+
+Here's an example:
+
+```shell
+ninja -C out/Default chrome_public_apk_incremental
+out/Default/bin/install_chrome_public_apk_incremental -v
+```
+
+For gunit tests (note that run_*_incremental automatically add
+--fast-local-dev when calling test\_runner.py):
+
+```shell
+ninja -C out/Default base_unittests_incremental
+out/Default/bin/run_base_unittests_incremental
+```
+
+For instrumentation tests:
+
+```shell
+ninja -C out/Default chrome_public_test_apk_incremental
+out/Default/bin/run_chrome_public_test_apk_incremental
+```
+
+To uninstall:
+
+```shell
+out/Default/bin/install_chrome_public_apk_incremental -v --uninstall
+```
+
+### Miscellaneous
+
+#### Rebuilding libchrome.so for a particular release
+
+In the case where you want to modify the native code for an existing
+release of Chrome for Android (v25+) you can do the following steps.
+Note that in order to get your changes into the official release, you'll
+need to send your change for a codereview using the regular process for
+committing code to chromium.
+
+1. Open Chrome on your Android device and visit chrome://version
+2. Copy down the id listed next to "Build ID:"
+3. Go to
+ [http://storage.googleapis.com/chrome-browser-components/BUILD\_ID\_FROM\_STEP\_2/index.html](http://storage.googleapis.com/chrome-browser-components/BUILD_ID_FROM_STEP_2/index.html)
+4. Download the listed files and follow the steps in the README.
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698