about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorEric Huss <eric@huss.org>2025-02-15 10:50:47 -0800
committerEric Huss <eric@huss.org>2025-03-27 19:04:56 -0700
commitec25e3300b930b9d2873fe589ed3cbfa55db3ffe (patch)
tree6808397bba745f149ba3d76efd6d8098ec6f3227 /src/doc/rustdoc
parent0340a865b9e7a3aa17a69555f0cc22ba3ad92c73 (diff)
downloadrust-ec25e3300b930b9d2873fe589ed3cbfa55db3ffe.tar.gz
rust-ec25e3300b930b9d2873fe589ed3cbfa55db3ffe.zip
Rename `--runtool` and `--runtool-arg`
This renames `--runtool` and `--runtool-arg` to `--test-runtool` and
`--test-runtool-arg` to maintain consistency with other `--test-*`
arguments.
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/unstable-features.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md
index d4ff69a9933..144f1c61b34 100644
--- a/src/doc/rustdoc/src/unstable-features.md
+++ b/src/doc/rustdoc/src/unstable-features.md
@@ -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.