about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorEric Huss <eric@huss.org>2025-03-27 18:20:04 -0700
committerEric Huss <eric@huss.org>2025-03-27 19:07:17 -0700
commitf535922f20d8061fc3c61b165cd7a4061500e751 (patch)
tree1085f49702be53129baa6d7b1f0c1cdaf4ac4381 /src/doc/rustdoc
parentaf2b4b94ed6f46392043f1c652f06f402d2713fc (diff)
downloadrust-f535922f20d8061fc3c61b165cd7a4061500e751.tar.gz
rust-f535922f20d8061fc3c61b165cd7a4061500e751.zip
Try to more clearly specify exactly what the runtool flags do
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/command-line-arguments.md11
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