about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-06-07 17:25:45 +0200
committerGitHub <noreply@github.com>2022-06-07 17:25:45 +0200
commit4851ec729aff6d4325c3afd15d93ccd49d6e2930 (patch)
tree688fde061a143080523daa3e9ac55660aca289c4
parentf12605b9ef252aadcba004485796116debefd2ae (diff)
parent5799e7de160ee5c4a9c9ab1121f7e5b70ccfc187 (diff)
downloadrust-4851ec729aff6d4325c3afd15d93ccd49d6e2930.tar.gz
rust-4851ec729aff6d4325c3afd15d93ccd49d6e2930.zip
Rollup merge of #97826 - GuillaumeGomez:rustdoc-gui-tests-info, r=Dylan-DPC
Add more information for rustdoc-gui tests

It was missing `--no-sandbox` in the `--help` message and the README was a bit outdated.

cc `@jsha` (I recall you asking some questions about passing arguments to the rustdoc gui tester so here it).

r? `@notriddle`
-rw-r--r--src/test/rustdoc-gui/README.md20
-rw-r--r--src/tools/rustdoc-gui/tester.js1
2 files changed, 16 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/
diff --git a/src/tools/rustdoc-gui/tester.js b/src/tools/rustdoc-gui/tester.js
index 4599e12de5f..a5121850369 100644
--- a/src/tools/rustdoc-gui/tester.js
+++ b/src/tools/rustdoc-gui/tester.js
@@ -16,6 +16,7 @@ function showHelp() {
     console.log("  --debug                    : show extra information about script run");
     console.log("  --show-text                : render font in pages");
     console.log("  --no-headless              : disable headless mode");
+    console.log("  --no-sandbox               : disable sandbox mode");
     console.log("  --help                     : show this message then quit");
     console.log("  --tests-folder [PATH]      : location of the .GOML tests folder");
     console.log("  --jobs [NUMBER]            : number of threads to run tests on");