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

Side by Side Diff: docs/chromoting_android_hacking.md

Issue 1318503005: A batch of docs style fixes. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 3 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 unified diff | Download patch
« no previous file with comments | « docs/chromium_browser_vs_google_chrome.md ('k') | docs/chromoting_build_instructions.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # Introduction 1 # Chromoting Android Hacking
2 2
3 This guide, which is meant to accompany the compilation guide at ChromotingBuild Instructions, explains the process of viewing the logs and debugging the CRD And roid client. I'll assume you've already built the APK as described in the afore mentioned guide, that you're in the `src/` directory, and that your binary is at `out/Release/apks/Chromoting.apk`. Additionally, you should have installed the app on at least one (still) connected device. 3 This guide, which is meant to accompany the
4 [compilation guide](chromoting_build_instructions.md), explains the process of
5 viewing the logs and debugging the CRD Android client. I'll assume you've
6 already built the APK as described in the aforementioned guide, that you're in
7 the `src/` directory, and that your binary is at
8 `out/Release/apks/Chromoting.apk`. Additionally, you should have installed the
9 app on at least one (still) connected device.
4 10
5 # Viewing logging output 11 [TOC]
6 12
7 In order to access LogCat and view the app's logging output, we need to launch t he Android Device Monitor. Run `third_party/android_tools/sdk/tools/monitor` an d select the desired device under `Devices`. Using the app as normal will displ ay log messages to the `LogCat` pane. 13 ## Viewing logging output
8 14
9 # Attaching debuggers for Java code 15 In order to access LogCat and view the app's logging output, we need to launch
16 the Android Device Monitor. Run `third_party/android_tools/sdk/tools/monitor`
17 and select the desired device under `Devices`. Using the app as normal will
18 display log messages to the `LogCat` pane.
10 19
11 ## Eclipse 20 ## Attaching debuggers for Java code
12 1. Go to http://developer.android.com/sdk/index.html and click "Download the S DK ADT Bundle for Linux" 21
13 1. Configure eclipse 22 ### Eclipse
14 1. Select General > Workspace from the tree on the left. 23
15 1. Uncheck Refresh workspace on startup (if present) 24 1. Go to http://developer.android.com/sdk/index.html and click "Download the
16 1. Uncheck Refresh using native hooks or polling (if present) 25 SDK ADT Bundle for Linux"
17 1. Disable build before launching 26 1. Configure eclipse
18 1. Select Run/Debug > Launching 27 1. Select General > Workspace from the tree on the left.
19 1. Uncheck Build (if required) before launching 28 1. Uncheck Refresh workspace on startup (if present)
20 1. Create a project 29 1. Uncheck Refresh using native hooks or polling (if present)
21 1. Select File > New > Project... from the main menu. 30 1. Disable build before launching
22 1. Choose Java/Java Project 31 1. Select Run/Debug > Launching
23 1. Eclipse should have generated .project and perhaps a .classpath file in y our <project root>/src/ directory. 32 1. Uncheck Build (if required) before launching
24 1. Replace/Add the .classpath file with the content from Below. Remember tha t the path field should be the location of the chromium source relative to the c urrent directory of your project. 33 1. Create a project
25 ``` 34 1. Select File > New > Project... from the main menu.
35 1. Choose Java/Java Project
36 1. Eclipse should have generated .project and perhaps a .classpath file in
37 your <project root>/src/ directory.
38 1. Replace/Add the .classpath file with the content from Below. Remember
39 that the path field should be the location of the chromium source
40 relative to the current directory of your project.
41
42 ```xml
26 <?xml version="1.0" encoding="UTF-8"?> 43 <?xml version="1.0" encoding="UTF-8"?>
27 <classpath> 44 <classpath>
28 <classpathentry kind="src" path="net/test/android/javatests/src"/> 45 <classpathentry kind="src" path="net/test/android/javatests/src"/>
29 <classpathentry kind="src" path="net/android/java/src"/> 46 <classpathentry kind="src" path="net/android/java/src"/>
30 <classpathentry kind="src" path="net/android/javatests/src"/> 47 <classpathentry kind="src" path="net/android/javatests/src"/>
31 <classpathentry kind="src" path="base/test/android/java/src"/> 48 <classpathentry kind="src" path="base/test/android/java/src"/>
32 <classpathentry kind="src" path="base/test/android/javatests/src"/> 49 <classpathentry kind="src" path="base/test/android/javatests/src"/>
33 <classpathentry kind="src" path="base/android/jni_generator/java/src"/> 50 <classpathentry kind="src" path="base/android/jni_generator/java/src"/>
34 <classpathentry kind="src" path="base/android/java/src"/> 51 <classpathentry kind="src" path="base/android/java/src"/>
35 <classpathentry kind="src" path="base/android/javatests/src"/> 52 <classpathentry kind="src" path="base/android/javatests/src"/>
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after
87 <classpathentry kind="src" path="android_webview/unittestjava/src"/> 104 <classpathentry kind="src" path="android_webview/unittestjava/src"/>
88 <classpathentry kind="src" path="android_webview/javatests/src"/> 105 <classpathentry kind="src" path="android_webview/javatests/src"/>
89 <classpathentry kind="src" path="content/public/test/android/javatests/src"/> 106 <classpathentry kind="src" path="content/public/test/android/javatests/src"/>
90 <classpathentry kind="src" path="content/public/android/java/src"/> 107 <classpathentry kind="src" path="content/public/android/java/src"/>
91 <classpathentry kind="src" path="content/public/android/javatests/src"/> 108 <classpathentry kind="src" path="content/public/android/javatests/src"/>
92 <classpathentry kind="src" path="content/shell/android/browsertests_apk/src"/> 109 <classpathentry kind="src" path="content/shell/android/browsertests_apk/src"/>
93 <classpathentry kind="src" path="content/shell/android/java/src"/> 110 <classpathentry kind="src" path="content/shell/android/java/src"/>
94 <classpathentry kind="src" path="content/shell/android/shell_apk/src"/> 111 <classpathentry kind="src" path="content/shell/android/shell_apk/src"/>
95 <classpathentry kind="src" path="content/shell/android/javatests/src"/> 112 <classpathentry kind="src" path="content/shell/android/javatests/src"/>
96 <classpathentry kind="src" path="content/shell/android/linker_test_apk/src"/> 113 <classpathentry kind="src" path="content/shell/android/linker_test_apk/src"/>
97 <classpathentry kind="lib" path="third_party/android_tools/sdk/platforms/android -19/data/layoutlib.jar"/> 114 <classpathentry kind="lib" path="third_party/android_tools/sdk/platforms/android -19/data/layoutlib.jar"/>
98 <classpathentry kind="lib" path="third_party/android_tools/sdk/platforms/android -19/android.jar"/> 115 <classpathentry kind="lib" path="third_party/android_tools/sdk/platforms/android -19/android.jar"/>
99 <classpathentry kind="output" path="out/bin"/> 116 <classpathentry kind="output" path="out/bin"/>
100 </classpath> 117 </classpath>
101 ``` 118 ```
102 1. Obtain the debug port
103 1. Go to Window > Open Perspective > DDMS
104 1. In order for the app org.chromium.chromoting to show up, you must build D ebug instead of Retail
105 1. Note down the port number, should be 8600 or 8700
106 1. Setup a debug configuration
107 1. Go to Window > Open Perspective > Debug
108 1. Run > Debug > Configurations
109 1. Select "Remote Java Application" and click "New"
110 1. Put Host: localhost and Port: <the port from DDMS>
111 1. Hit Debug
112 1. Configure source path
113 1. Right click on the Chromoting [Application](Remoting.md) and select Edit source Lookup Path
114 1. Click "Add" and select File System Directory
115 1. Select the location of your chromium checkout, e.g. <project root>/src/re moting/android
116 1. Debugging
117 1. To add a breakpoint, simply open the source file and hit Ctrl+Shift+B to toggle the breakpoint. Happy hacking.
118 ## Command line debugger
119 119
120 With the Android Device Monitor open, look under `Devices`, expand the entry for the device on which you want to debug, and select the entry for `org.chromium.c hromoting` (it must already be running). This forwards the JVM debugging connec tion to your local port 8700. In your shell, do `$ jdb -attach localhost:8700`. 120 1. Obtain the debug port
121 1. Go to Window > Open Perspective > DDMS
122 1. In order for the app org.chromium.chromoting to show up, you must build
123 Debug instead of Retail
124 1. Note down the port number, should be 8600 or 8700
125 1. Setup a debug configuration
126 1. Go to Window > Open Perspective > Debug
127 1. Run > Debug > Configurations
128 1. Select "Remote Java Application" and click "New"
129 1. Put Host: localhost and Port: <the port from DDMS>
130 1. Hit Debug
131 1. Configure source path
132 1. Right click on the Chromoting [Application](Remoting.md) and select Edit
133 source Lookup Path
134 1. Click "Add" and select File System Directory
135 1. Select the location of your chromium checkout,
136 e.g. <project root>/src/remoting/android
137 1. Debugging
138 1. To add a breakpoint, simply open the source file and hit Ctrl+Shift+B to
139 toggle the breakpoint. Happy hacking.
121 140
122 # Attaching GDB to debug native code 141 ### Command line debugger
123 142
124 The Chromium build system provides a convenience wrapper script that can be used to easily launch GDB. Run `$ build/android/adb_gdb --package-name=org.chromium .chromoting --activity=.Chromoting --start`. Note that if you have multiple dev ices connected, you must export `ANDROID_SERIAL` to select one; set it to the se rial number of the desired device as output by `$ adb devices`. 143 With the Android Device Monitor open, look under `Devices`, expand the entry for
144 the device on which you want to debug, and select the entry for
145 `org.chromium.chromoting` (it must already be running). This forwards the JVM
146 debugging connection to your local port 8700. In your shell, do `$ jdb -attach
147 localhost:8700`.
148
149 ## Attaching GDB to debug native code
150
151 The Chromium build system provides a convenience wrapper script that can be used
152 to easily launch GDB. Run
153
154 ```shell
155 $ build/android/adb_gdb --package-name=org.chromium.chromoting \
156 --activity=.Chromoting --start
157 ```
158
159 Note that if you have multiple devices connected, you must export
160 `ANDROID_SERIAL` to select one; set it to the serial number of the desired
161 device as output by `$ adb devices`.
OLDNEW
« no previous file with comments | « docs/chromium_browser_vs_google_chrome.md ('k') | docs/chromoting_build_instructions.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698