Skip to content

Commit f535922

Browse files
committed
Try to more clearly specify exactly what the runtool flags do
1 parent af2b4b9 commit f535922

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/doc/rustdoc/src/command-line-arguments.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -224,14 +224,19 @@ See also `--test`.
224224

225225
## `--test-runtool`, `--test-runtool-arg`: program to run tests with; args to pass to it
226226

227+
A doctest wrapper program can be specified with the `--test-runtool` flag.
228+
Rustdoc will execute that wrapper instead of the doctest executable when
229+
running tests. The first arguments to the wrapper will be any arguments
230+
specified with the `--test-runtool-arg` flag, followed by the path to the
231+
doctest executable to run.
232+
227233
Using these options looks like this:
228234

229235
```bash
230-
$ rustdoc src/lib.rs --test-runtool runner --test-runtool-arg --do-thing --test-runtool-arg --do-other-thing
236+
$ rustdoc src/lib.rs --test-runtool path/to/runner --test-runtool-arg --do-thing --test-runtool-arg --do-other-thing
231237
```
232238

233-
These options can be used to run the doctest under a program, and also pass arguments to
234-
that program. For example, if you want to run your doctests under valgrind you might run
239+
For example, if you want to run your doctests under valgrind you might run:
235240

236241
```bash
237242
$ rustdoc src/lib.rs --test-runtool valgrind

0 commit comments

Comments
 (0)