Chromium Code Reviews Chromium Code Reviews
Issue 1158323008:
Expand the devtools/common readme. (Closed)
Base URL: git@github.com:domokit/mojo.git@master| Index: mojo/devtools/common/README.md |
| diff --git a/mojo/devtools/common/README.md b/mojo/devtools/common/README.md |
| index 07d6db82f566cfaa232a895dfb7b0d53e4a00151..193637dc3d5517835aa4de8d5749e4ad1288c197 100644 |
| --- a/mojo/devtools/common/README.md |
| +++ b/mojo/devtools/common/README.md |
| @@ -2,8 +2,39 @@ |
| Unopinionated tools for **running**, **debugging** and **testing** Mojo apps. |
| +The repo consists of: |
| + |
| + - **devtoolslib** - Python module containing the core scripting functionality: |
| + shell abstraction with implementations for Android and Linux and support for |
| + apptest frameworks, and |
|
tonyg
2015/06/04 17:33:20
recommend dropping ", and"
ppi
2015/06/04 17:37:00
Done.
|
| + - executable scripts |
|
tonyg
2015/06/04 17:33:20
Maybe **executable scripts** - one sentence descri
ppi
2015/06/04 17:37:00
Done.
|
| + |
| +## Embedding devtoolslib |
| + |
| +As devtools carry no assumptions about build system or file layout being used, |
| +the primary way of using devtools now is to embed the functionality provided by |
| +**devtoolslib** in a thin wrapper script. For examples, one can refer to |
| +[this](https://github.com/domokit/mojo/blob/master/mojo/tools/mojo_shell.py) |
|
tonyg
2015/06/04 17:33:19
recommend eliminating "this" and linking the work
ppi
2015/06/04 17:37:00
Done.
|
| +shell runner, or |
| +[that](https://github.com/domokit/mojo/blob/master/mojo/tools/apptest_runner.py) |
| +apptest runner. |
| + |
| +## Executable scripts |
| + |
| +The set of executable scripts is WIP. We currently offer: |
| + |
| + - **debugger** - allowing to send commands to the mojo:debugger app running in |
| + the shell, allowing e.g. to interactively start and stop tracing |
| + |
| ## Install |
| ``` |
| git clone https://github.com/domokit/devtools.git |
| ``` |
| + |
| +## File location |
| + |
| +The library is canonically developed [in the mojo |
| +repository](https://github.com/domokit/mojo/tree/master/mojo/devtools/common), |
| +https://github.com/domokit/devtools is a mirror allowing to consume it |
| +separately. |
