user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename --runtool and --runtool-arg

Browse source 
This renames `--runtool` and `--runtool-arg` to `--test-runtool` and
`--test-runtool-arg` to maintain consistency with other `--test-*`
arguments.
This commit is contained in:
Eric Huss 2025-02-15 10:50:47 -08:00
parent 0340a865b9
commit ec25e3300b
9 changed files with 29 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/doc/rustdoc/src/unstable-features.md
View file

@ -666,21 +666,21 @@ struct Foo;
In older versions, this will be ignored on all targets, but on newer versions `ignore-gnu` will
override `ignore`.
## `--runtool`, `--runtool-arg`: program to run tests with; args to pass to it
## `--test-runtool`, `--test-runtool-arg`: program to run tests with; args to pass to it
* Tracking issue: [#64245](https://github.com/rust-lang/rust/issues/64245)
Using these options looks like this:
```bash
$ rustdoc src/lib.rs -Z unstable-options --runtool runner --runtool-arg --do-thing --runtool-arg --do-other-thing
$ rustdoc src/lib.rs -Z unstable-options --test-runtool runner --test-runtool-arg --do-thing --test-runtool-arg --do-other-thing
```
These options can be used to run the doctest under a program, and also pass arguments to
that program. For example, if you want to run your doctests under valgrind you might run
```bash
$ rustdoc src/lib.rs -Z unstable-options --runtool valgrind
$ rustdoc src/lib.rs -Z unstable-options --test-runtool valgrind
```
Another use case would be to run a test inside an emulator, or through a Virtual Machine.