about summary refs log tree commit diff
path: root/config.example.toml
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2024-03-06 12:10:52 -0800
committerAlex Crichton <alex@alexcrichton.com>2024-03-08 07:44:03 -0800
commitdd95cb7106e60a79a994899aa4836d6dc8b5b9fa (patch)
tree8be313e6b712be37ef2d10cfef066e7152aedf76 /config.example.toml
parent42825768b103c28b10ce0407749acb21d32abeec (diff)
downloadrust-dd95cb7106e60a79a994899aa4836d6dc8b5b9fa.tar.gz
rust-dd95cb7106e60a79a994899aa4836d6dc8b5b9fa.zip
Add `target.*.runner` configuration for targets
This commit adds a `runner` field configuration to `config.toml` for
specifying a wrapper executable when executing binaries for a target.
This is pulled out of #122036 where a WebAssembly runtime is used, for
example, to execute tests for `wasm32-wasip1`.

The name "runner" here is chosen to match Cargo's `CARGO_*_RUNNER`
configuration, and to make things a bit more consistent this
additionally renames compiletest's `--runtool` argument to `--runner`.
Diffstat (limited to 'config.example.toml')
-rw-r--r--config.example.toml11
1 files changed, 11 insertions, 0 deletions
diff --git a/config.example.toml b/config.example.toml
index c1939933850..4fbdccba911 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -842,6 +842,17 @@
 # See that option for more info.
 #codegen-backends = rust.codegen-backends (array)
 
+# This is a "runner" to pass to `compiletest` when executing tests. Tests will
+# execute this tool where the binary-to-test is passed as an argument. Can
+# be useful for situations such as when WebAssembly is being tested and a
+# runtime needs to be configured. This value is similar to
+# Cargo's `CARGO_$target_RUNNER` configuration.
+#
+# This configuration is a space-separated list of arguments so `foo bar` would
+# execute the program `foo` with the first argument as `bar` and the second
+# argument as the test binary.
+#runner = <none> (string)
+
 # =============================================================================
 # Distribution options
 #