diff options
| author | Guillaume Gomez <guillaume.gomez@huawei.com> | 2022-06-07 11:49:35 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume.gomez@huawei.com> | 2022-06-07 11:49:35 +0200 |
| commit | 5799e7de160ee5c4a9c9ab1121f7e5b70ccfc187 (patch) | |
| tree | e3cb3f4e30baebcbe4c317fc21d2c84c86908aca | |
| parent | 232c2d6c256eed76f24bd6cf249a8462ab297060 (diff) | |
| download | rust-5799e7de160ee5c4a9c9ab1121f7e5b70ccfc187.tar.gz rust-5799e7de160ee5c4a9c9ab1121f7e5b70ccfc187.zip | |
Update rustdoc-gui README
| -rw-r--r-- | src/test/rustdoc-gui/README.md | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/src/test/rustdoc-gui/README.md b/src/test/rustdoc-gui/README.md index 8efe7a578b8..d9854e2e715 100644 --- a/src/test/rustdoc-gui/README.md +++ b/src/test/rustdoc-gui/README.md @@ -11,14 +11,24 @@ You can find more information and its documentation in its [repository][browser- If you need to have more information on the tests run, you can use `--test-args`: ```bash -$ ./x.py test src/test/rustdoc-gui --stage 1 --jobs 8 --test-args --debug +$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --debug ``` -There are three options supported: +If you don't want to run in headless mode (helpful to debug sometimes), you can use +`--no-headless`: - * `--debug`: allows to see puppeteer commands. - * `--no-headless`: disable headless mode so you can see what's going on. - * `--show-text`: by default, text isn't rendered because of issues with fonts, it enables it back. +```bash +$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-headless +``` + +To see the supported options, use `--help`. + +Important to be noted: if the chromium instance crashes when you run it, you might need to +use `--no-sandbox` to make it work: + +```bash +$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-sandbox +``` [browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/ [puppeteer]: https://pptr.dev/ |