Skip to content

Commit 290bf08

Browse files
committed
[docs] Update Testing.md for remote-run support
1 parent 816c4df commit 290bf08

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/Testing.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ targets mentioned above and modify it as necessary. lit.py also has several
8080
useful features, like timing tests and providing a timeout. Check these features
8181
out with ``lit.py -h``. We document some of the more useful ones below:
8282

83-
##### Extra lit.py invocation options
83+
##### Standard lit.py invocation options
8484

8585
* ``-s`` reduces the amount of output that lit shows.
8686
* ``-v`` causes a test's commandline and output to be printed if the test fails.
@@ -100,6 +100,9 @@ out with ``lit.py -h``. We document some of the more useful ones below:
100100
running a single test (in seconds). 0 (the default means no time limit.
101101
* ``--max-failures=<MAXFAILURES>`` stops execution after ``MAXFAILURES`` number
102102
of failures.
103+
104+
##### Swift-specific testing options
105+
103106
* ``--param gmalloc`` will run all tests under Guard Malloc (macOS only). See
104107
``man libgmalloc`` for more information.
105108
* ``--param swift-version=<MAJOR>`` overrides the default Swift language
@@ -111,6 +114,22 @@ out with ``lit.py -h``. We document some of the more useful ones below:
111114
mentioned above. Again, it's best to get the invocation from the existing
112115
build system targets and modify it rather than constructing it yourself.
113116

117+
##### Remote testing options
118+
119+
* ``--param remote_run_host=[USER@]<HOST>[:PORT]`` causes execution tests that
120+
would normally be run on the host (via the ``%target-run`` substitutions
121+
described below) to be run over SSH on another machine instead, using the
122+
`remote-run` tool in the `utils` directory. Requires that `remote_run_tmpdir`
123+
also be provided.
124+
* ``--param remote_run_tmpdir=<PATH>`` specifies the scratch directory to be
125+
used on the remote machine when testing with `remote_run_host`.
126+
* ``--param remote_run_identity=<FILE>`` provides an SSH private key to be used
127+
when testing with `remote_run_host`. (`remote-run` does not support
128+
passwords.)
129+
* ``--param remote_run_skip_upload_stdlib`` assumes that the standard library
130+
binaries have already been uploaded to `remote_run_tmpdir` and are up to date.
131+
This is meant for repeat runs and probably shouldn't be used in automation.
132+
114133
#### CMake
115134

116135
Although it is not recommended for day-to-day contributions, it is also

0 commit comments

Comments
 (0)