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

Try to more clearly specify exactly what the runtool flags do

Browse source
This commit is contained in:
Eric Huss 2025-03-27 18:20:04 -07:00
parent af2b4b94ed
commit f535922f20
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/doc/rustdoc/src/command-line-arguments.md
View file

@ -224,14 +224,19 @@ See also `--test`.
## `--test-runtool`, `--test-runtool-arg`: program to run tests with; args to pass to it
A doctest wrapper program can be specified with the `--test-runtool` flag.
Rustdoc will execute that wrapper instead of the doctest executable when
running tests. The first arguments to the wrapper will be any arguments
specified with the `--test-runtool-arg` flag, followed by the path to the
doctest executable to run.
Using these options looks like this:
```bash
$ rustdoc src/lib.rs --test-runtool runner --test-runtool-arg --do-thing --test-runtool-arg --do-other-thing
$ rustdoc src/lib.rs --test-runtool path/to/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
For example, if you want to run your doctests under valgrind you might run:
```bash
$ rustdoc src/lib.rs --test-runtool valgrind