firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs about --local-engine (#4274)

Browse Source
This commit is contained in:
Adam Barth 2016-05-31 10:28:25 -07:00
parent 7de84709cf
commit b4002506e7
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -85,8 +85,9 @@ Flutter tests use [package:flutter_test](https://github.com/flutter/flutter/tree
To run all the tests for the entire Flutter repository, the same way that Travis runs them, run `dev/bots/test.sh`. To run all the tests for the entire Flutter repository, the same way that Travis runs them, run `dev/bots/test.sh`.
If you've built [your own flutter engine](#working-on-the-engine-and-the-framework-at-the-same-time), you can pass `--engine-debug` or `--engine-release` to change what flutter shell `flutter test` uses. If you've built [your own flutter engine](#working-on-the-engine-and-the-framework-at-the-same-time), you can pass `--local-engine` to change what flutter shell `flutter test` uses. For example,
To do this with the `dev/bots/test.sh` script, you can use the `FLUTTER_ENGINE` environment variable. if you built an engine in the `out/host_debug_unopt` directory, you can pass
`--local-engine=host_debug_unopt` to run the tests in that engine.
Note: Flutter tests are headless, you won't see any UI. You can use Note: Flutter tests are headless, you won't see any UI. You can use
`print` to generate console output or you can interact with the DartVM `print` to generate console output or you can interact with the DartVM
@ -161,18 +162,15 @@ the following steps.
underneath the directory that contains the `.gclient` file. underneath the directory that contains the `.gclient` file.
3. To run tests on your host machine, build one of the host configurations 3. To run tests on your host machine, build one of the host configurations
(e.g., `out/Debug`). To run examples on Android, build one of the Android (e.g., `out/host_debug_unopt`). To run examples on Android, build one of the
configurations (e.g., `out/android_Debug`). Android configurations (e.g., `out/android_debug_unopt`).
You should now be able to run the tests against your locally built You should now be able to run the tests against your locally built
engine using the `flutter test --engine-debug` command. To run one of the engine using the `flutter test --local-engine=host_debug_unopt` command. To run
examples on your device using your locally built engine, use the one of the examples on your device using your locally built engine, use the
`--engine-debug` option to the `flutter` tool: `--local-engine=android_debug_unopt` option to the `flutter` tool:
* `flutter run --engine-debug` * `flutter run --local-engine=android_debug_unopt`
If you want to test the release version instead of the debug version,
use `--engine-release` instead of `--engine-debug`.
Making a breaking change to the engine Making a breaking change to the engine
-------------------------------------- --------------------------------------