Skip to content

Commit f69abab

Browse files
authored
Update test-suite docs. NFC (#25774)
1 parent c1e8d14 commit f69abab

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

site/source/docs/getting_started/test-suite.rst

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -204,9 +204,20 @@ To further customize how the benchmarks are run, you will want to edit the file
204204
Debugging test failures
205205
=======================
206206

207-
Setting the :ref:`debugging-EMCC_DEBUG` is useful for debugging tests, as it
208-
emits debug output and intermediate files (the files go in
209-
**/tmp/emscripten_temp/**):
207+
By default the test runner will hide all test output and use a single terminal
208+
line to show test results.
209+
210+
If you want to see more information you can run with ``-v/--verbose`` to show the
211+
stdout / stderr / logging produced during each test.
212+
213+
If you add a second ``-v/--verbose`` then then test runner will output even more
214+
information. For example it will show all the subcommands that it runs, as it
215+
runs them.
216+
217+
For even more debugging info, you can set :ref:`debugging-EMCC_DEBUG` which will
218+
cause the emscripten compiler itself to output a lot of debug info. This will
219+
also tell the compiler to leave all its temporary files behind after it runs
220+
(the files go in ``/tmp/emscripten_temp/``):
210221

211222
.. code-block:: bash
212223
@@ -222,11 +233,11 @@ emits debug output and intermediate files (the files go in
222233
EMCC_DEBUG=2 test/runner test_hello_world
223234
224235
225-
You can also specify ``--save-dir`` to save the temporary directory that the
226-
test runner uses into **/out/test/**. This is a test suite-specific
227-
feature, and is useful for inspecting test outputs as well as temporary files
228-
generated by the test. By default, the temporary directory will be cleaned
229-
between each test run, but you can add ``--no-clean`` to avoid this.
236+
If you run just one a single test (or one test at at time using ``-j1``) the test
237+
output can always be found in ``out/test``. This is useful for inspecting test
238+
outputs as well as temporary files generated by the test. By default, the temporary
239+
directory will be cleaned between each test run, but you can add ``--no-clean`` to
240+
avoid this.
230241

231242
The :ref:`Debugging` topic provides more guidance on how to debug
232243
Emscripten-generated code.

0 commit comments

Comments
 (0)