Skip to content

Commit 27acd5e

Browse files
authored
Rollup merge of rust-lang#133191 - aDotInTheVoid:whoops-thats-not-stable-and-might-never-be, r=fmease
rustdoc book: Move `--test-builder(--wrapper)?` docs to unstable section. Tracking issue: rust-lang#102981 These have always been unstable, but were documented in the stable section in rust-lang#114651
2 parents 739fdaf + ed465f2 commit 27acd5e

File tree

2 files changed

+33
-29
lines changed

2 files changed

+33
-29
lines changed

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

-29
Original file line numberDiff line numberDiff line change
@@ -447,32 +447,3 @@ This flag is **deprecated** and **has no effect**.
447447
Rustdoc only supports Rust source code and Markdown input formats. If the
448448
file ends in `.md` or `.markdown`, `rustdoc` treats it as a Markdown file.
449449
Otherwise, it assumes that the input file is Rust.
450-
451-
## `--test-builder`: `rustc`-like program to build tests
452-
453-
Using this flag looks like this:
454-
455-
```bash
456-
$ rustdoc --test-builder /path/to/rustc src/lib.rs
457-
```
458-
459-
Rustdoc will use the provided program to compile tests instead of the default `rustc` program from
460-
the sysroot.
461-
462-
## `--test-builder-wrapper`: wrap calls to the test builder
463-
464-
Using this flag looks like this:
465-
466-
```bash
467-
$ rustdoc --test-builder-wrapper /path/to/rustc-wrapper src/lib.rs
468-
$ rustdoc \
469-
--test-builder-wrapper rustc-wrapper1 \
470-
--test-builder-wrapper rustc-wrapper2 \
471-
--test-builder rustc \
472-
src/lib.rs
473-
```
474-
475-
Similar to cargo `build.rustc-wrapper` option, this flag takes a `rustc` wrapper program.
476-
The first argument to the program will be the test builder program.
477-
478-
This flag can be passed multiple times to nest wrappers.

src/doc/rustdoc/src/unstable-features.md

+33
Original file line numberDiff line numberDiff line change
@@ -627,3 +627,36 @@ add the `--scrape-tests` flag.
627627

628628
This flag enables the generation of links in the source code pages which allow the reader
629629
to jump to a type definition.
630+
631+
### `--test-builder`: `rustc`-like program to build tests
632+
633+
* Tracking issue: [#102981](https://github.com/rust-lang/rust/issues/102981)
634+
635+
Using this flag looks like this:
636+
637+
```bash
638+
$ rustdoc --test-builder /path/to/rustc src/lib.rs
639+
```
640+
641+
Rustdoc will use the provided program to compile tests instead of the default `rustc` program from
642+
the sysroot.
643+
644+
### `--test-builder-wrapper`: wrap calls to the test builder
645+
646+
* Tracking issue: [#102981](https://github.com/rust-lang/rust/issues/102981)
647+
648+
Using this flag looks like this:
649+
650+
```bash
651+
$ rustdoc -Zunstable-options --test-builder-wrapper /path/to/rustc-wrapper src/lib.rs
652+
$ rustdoc -Zunstable-options \
653+
--test-builder-wrapper rustc-wrapper1 \
654+
--test-builder-wrapper rustc-wrapper2 \
655+
--test-builder rustc \
656+
src/lib.rs
657+
```
658+
659+
Similar to cargo `build.rustc-wrapper` option, this flag takes a `rustc` wrapper program.
660+
The first argument to the program will be the test builder program.
661+
662+
This flag can be passed multiple times to nest wrappers.

0 commit comments

Comments
 (0)