Skip to content

Commit 5799e7d

Browse files
Update rustdoc-gui README
1 parent 232c2d6 commit 5799e7d

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

src/test/rustdoc-gui/README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,24 @@ You can find more information and its documentation in its [repository][browser-
1111
If you need to have more information on the tests run, you can use `--test-args`:
1212

1313
```bash
14-
$ ./x.py test src/test/rustdoc-gui --stage 1 --jobs 8 --test-args --debug
14+
$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --debug
1515
```
1616

17-
There are three options supported:
17+
If you don't want to run in headless mode (helpful to debug sometimes), you can use
18+
`--no-headless`:
1819

19-
* `--debug`: allows to see puppeteer commands.
20-
* `--no-headless`: disable headless mode so you can see what's going on.
21-
* `--show-text`: by default, text isn't rendered because of issues with fonts, it enables it back.
20+
```bash
21+
$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-headless
22+
```
23+
24+
To see the supported options, use `--help`.
25+
26+
Important to be noted: if the chromium instance crashes when you run it, you might need to
27+
use `--no-sandbox` to make it work:
28+
29+
```bash
30+
$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-sandbox
31+
```
2232

2333
[browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/
2434
[puppeteer]: https://pptr.dev/

0 commit comments

Comments
 (0)