diff options
| author | León Orell Valerian Liehr <me@fmease.dev> | 2025-02-05 05:03:06 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-02-05 05:03:06 +0100 |
| commit | a6ebb87b3a32f752f8b5cc40f18b83cc233b2d96 (patch) | |
| tree | 9668a1021a96e636c52168f23904544927d68da4 /src/doc | |
| parent | 058ed2b637e8261e7528124a60f82401895b83bd (diff) | |
| parent | f5d5210d26d29faad12c6aa7ef55aefa8d9f6ce9 (diff) | |
| download | rust-a6ebb87b3a32f752f8b5cc40f18b83cc233b2d96.tar.gz rust-a6ebb87b3a32f752f8b5cc40f18b83cc233b2d96.zip | |
Rollup merge of #136405 - aDotInTheVoid:unstable-doc, r=notriddle
rustdoc-book: Clean up section on `--output-format` Followup to #134531. Tracking issues #76578 and #134529 I guess. r? ``@GuillaumeGomez``
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index 7eb1b8df233..3abd538d372 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -330,7 +330,7 @@ the source. ## `--show-type-layout`: add a section to each type's docs describing its memory layout -* Tracking issue: [#113248](https://github.com/rust-lang/rust/issues/113248) + * Tracking issue: [#113248](https://github.com/rust-lang/rust/issues/113248) Using this flag looks like this: @@ -526,9 +526,10 @@ use `-o -`. ### json + * Tracking Issue: [#76578](https://github.com/rust-lang/rust/issues/76578) + `--output-format json` emits documentation in the experimental -[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/). `--output-format html` has no effect, -and is also accepted on stable toolchains. +[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/). JSON Output for toolchain crates (`std`, `alloc`, `core`, `test`, and `proc_macro`) is available via the `rust-docs-json` rustup component. @@ -546,11 +547,11 @@ information. ### doctest + * Tracking issue: [#134529](https://github.com/rust-lang/rust/issues/134529) + `--output-format doctest` emits JSON on stdout which gives you information about doctests in the provided crate. -Tracking issue: [#134529](https://github.com/rust-lang/rust/issues/134529) - You can use this option like this: ```bash @@ -606,6 +607,11 @@ The generated output (formatted) will look like this: * `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. * `name` is the name generated by rustdoc which represents this doctest. +### html + +`--output-format html` has no effect, as the default output is HTML. This is +accepted on stable, even though the other options for this flag aren't. + ## `--enable-per-target-ignores`: allow `ignore-foo` style filters for doctests * Tracking issue: [#64245](https://github.com/rust-lang/rust/issues/64245) |