Skip to content

Commit 85b7b4b

Browse files
author
ematejska
authored
Updating Testing instructions with utils/run-test
Updating Testing instructions with utils/run-test. I find this utility useful and others might too.
1 parent 85c4e01 commit 85b7b4b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/Testing.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,22 @@ test suite, via ``utils/build-script --validation-test``.
4949
Using ``utils/build-script`` will rebuild all targets which can add substantial
5050
time to a debug cycle.
5151

52+
#### Using utils/run-test
53+
54+
Using `utils/run-test` allows the user to run a single test or tests in a specific directory.
55+
This can significantly speed up the debug cycle. One can use this tool
56+
instead of invoking `lit.py` directly as described in the next section.
57+
58+
Here is an example of running the `test/Parse` tests:
59+
```
60+
% ${swift_SOURCE_ROOT}/utils/run-test --build-dir ${SWIFT_BUILD_DIR} ${swift_SOURCE_ROOT}/test/Parse
61+
```
62+
Note that one example of a valid `${SWIFT_BUILD_DIR}` is
63+
`{swift_SOURCE_ROOT}/../build/Ninja-DebugAssert/swift-linux-x86_64`.
64+
It differs based on your build options and on which directory you invoke the script from.
65+
66+
For full help options, pass `-h` to `utils/run-test` utility.
67+
5268
#### Using lit.py
5369

5470
Using `lit.py` directly can provide more control and faster feedback to your

0 commit comments

Comments
 (0)