diff options
| -rw-r--r-- | src/doc/rustdoc/src/command-line-arguments.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md index ac5c7f5b659..b55ddf6e0e1 100644 --- a/src/doc/rustdoc/src/command-line-arguments.md +++ b/src/doc/rustdoc/src/command-line-arguments.md @@ -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 |