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

Side by Side Diff: blimp/docs/running.md

Issue 2345673004: Updating blimp_shell doc (Closed)
Patch Set: Created 4 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 | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # Running Blimp 1 # Running Blimp
2 [TOC] 2 [TOC]
3 3
4 See [build](build.md) for instructions on how to build Blimp. 4 See [build](build.md) for instructions on how to build Blimp.
5 5
6 ## Android Client 6 ## Android Client
7 7
8 ### Installing the client 8 ### Installing the client
9 9
10 Install the Chrome Public APK with the following: 10 Install the Chrome Public APK with the following:
(...skipping 135 matching lines...) Expand 10 before | Expand all | Expand 10 after
146 Follow the instruction above to use `adb` directly. 146 Follow the instruction above to use `adb` directly.
147 147
148 * To connect to an Engine running on the host machine, you should use 148 * To connect to an Engine running on the host machine, you should use
149 `10.0.2.2` as `engine-ip` instead of `127.0.0.1` as `127.0.0.1` will refer to 149 `10.0.2.2` as `engine-ip` instead of `127.0.0.1` as `127.0.0.1` will refer to
150 the emulator itself. There is no need of set up 150 the emulator itself. There is no need of set up
151 [port forwarding](#Port-forwarding) when this approach is used. 151 [port forwarding](#Port-forwarding) when this approach is used.
152 152
153 ## Linux Client 153 ## Linux Client
154 154
155 The Linux client is used for development purpose while the Android client is 155 The Linux client is used for development purpose while the Android client is
156 shipped. The Linux client is built as part of the `blimp` target. 156 shipped. The Linux client is not built as part of the `blimp` target. It require s x11 which is not defined in the engine.
Wez 2016/09/16 00:12:38 nit: Let's rephrase this to just "The Linux client
scf 2016/09/16 00:15:00 Acknowledged.
157
158 Build with the following commands:
159 ```
160 mkdir -p out-linux/Client
161 echo "" > out-linux/Client/args.gn
Wez 2016/09/16 00:12:38 Do you need this? Shouldn't "gn gen out-linux/Cli
scf 2016/09/16 00:15:00 Acknowledged.
162
163 gn gen out-linux/Client
164 ninja -C out-linux/Client blimp_shell
165 ```
166
167
157 To run it with local logging enabled, execute: 168 To run it with local logging enabled, execute:
158 169
159 ```bash 170 ```bash
160 ./out-linux/Debug/blimp_shell \ 171 ./out-linux/Client/blimp_shell \
161 --user-data-dir=/tmp/blimpclient \ 172 --user-data-dir=/tmp/blimpclient \
162 --enable-logging=stderr \ 173 --enable-logging=stderr \
163 --vmodule="*=1" 174 --vmodule="*=1" \
175 --engine-ip=127.0.0.1 \
176 --engine-port=25467 \
177 --engine-transport=tcp \
178 --blimp-client-token-path=/tmp/blimpengine-token
164 ``` 179 ```
165 180
181 **PS:** The `/tmp/blimpengine-token` is a file any sequence of characters. Just make sure when you start the engine, you use the same file.
Wez 2016/09/16 00:12:38 Let's be explicit on the requirements here; is an
scf 2016/09/16 00:15:00 Acknowledged.
182
166 ## Running the engine 183 ## Running the engine
167 184
168 ### In a container 185 ### In a container
169 For running the engine in a container, see [container](container.md). 186 For running the engine in a container, see [container](container.md).
170 187
171 ### On a workstation 188 ### On a workstation
172 The following flags are required to start an Engine instance: 189 The following flags are required to start an Engine instance:
173 190
174 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty 191 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty
175 token string. If this is not present, the engine will fail to boot. 192 token string. If this is not present, the engine will fail to boot.
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after
255 killing engine if keyboard interrupts or client gets killed. 272 killing engine if keyboard interrupts or client gets killed.
256 273
257 ```bash 274 ```bash
258 out-linux/Debug/bin/client_engine_integration run 275 out-linux/Debug/bin/client_engine_integration run
259 ``` 276 ```
260 277
261 2. Same as step 2 in Option A. 278 2. Same as step 2 in Option A.
262 279
263 3. Engine should be auto-killed by keyboard stopping the `{run}` script or the client 280 3. Engine should be auto-killed by keyboard stopping the `{run}` script or the client
264 gets wiped out. `{stop}` works as well. 281 gets wiped out. `{stop}` works as well.
OLDNEW
« 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