Skip to content

Commit f5d5210

Browse files
committed
rustdoc-book: Clean up section on --output-format
1 parent e08cd3c commit f5d5210

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

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

+11-5
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ the source.
330330

331331
## `--show-type-layout`: add a section to each type's docs describing its memory layout
332332

333-
* Tracking issue: [#113248](https://github.com/rust-lang/rust/issues/113248)
333+
* Tracking issue: [#113248](https://github.com/rust-lang/rust/issues/113248)
334334

335335
Using this flag looks like this:
336336

@@ -526,9 +526,10 @@ use `-o -`.
526526

527527
### json
528528

529+
* Tracking Issue: [#76578](https://github.com/rust-lang/rust/issues/76578)
530+
529531
`--output-format json` emits documentation in the experimental
530-
[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/). `--output-format html` has no effect,
531-
and is also accepted on stable toolchains.
532+
[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/).
532533

533534
JSON Output for toolchain crates (`std`, `alloc`, `core`, `test`, and `proc_macro`)
534535
is available via the `rust-docs-json` rustup component.
@@ -546,11 +547,11 @@ information.
546547

547548
### doctest
548549

550+
* Tracking issue: [#134529](https://github.com/rust-lang/rust/issues/134529)
551+
549552
`--output-format doctest` emits JSON on stdout which gives you information about doctests in the
550553
provided crate.
551554

552-
Tracking issue: [#134529](https://github.com/rust-lang/rust/issues/134529)
553-
554555
You can use this option like this:
555556

556557
```bash
@@ -606,6 +607,11 @@ The generated output (formatted) will look like this:
606607
* `doctest_code` is the code modified by rustdoc that will be run. If there is a fatal syntax error, this field will not be present.
607608
* `name` is the name generated by rustdoc which represents this doctest.
608609

610+
### html
611+
612+
`--output-format html` has no effect, as the default output is HTML. This is
613+
accepted on stable, even though the other options for this flag aren't.
614+
609615
## `--enable-per-target-ignores`: allow `ignore-foo` style filters for doctests
610616

611617
* Tracking issue: [#64245](https://github.com/rust-lang/rust/issues/64245)

0 commit comments

Comments
 (0)