Skip to content

Commit 0f8db3b

Browse files
committed
rustdoc: add docs for --emit
1 parent 64349b0 commit 0f8db3b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,19 @@ Markdown file, the URL given to `--markdown-playground-url` will take precedence
269269
`--playground-url` and `#![doc(html_playground_url = "url")]` are present when rendering crate docs,
270270
the attribute will take precedence.
271271

272+
### `--emit`: Control rustdoc output
273+
274+
Assigned to a comma-separated list of formats to output:
275+
276+
- `invocation-specific`: Write files that are specific to the current crate (to `--out-dir`.
277+
- `toolchain-shared-resources`: Write output that is the same for any crate to `--out-dir`. This only applies to HTML, which relies on static files for styling and functionality.
278+
- `dep-info[=FILENAME]`: Write a file (in Makefile-compatible syntax) listing every file or environment variable that affects the output.
279+
280+
By default, Rustdoc emits `invocation-specific,toolchain-shared-resources`.
281+
When this parameter is supplied, it overrides the default, so
282+
`--emit=invocation-specific,toolchain-specific,dep-info` writes everything, and
283+
`--emit=dep-info` only writes dep-info.
284+
272285
## `--sort-modules-by-appearance`: control how items on module pages are sorted
273286

274287
Using this flag looks like this:

0 commit comments

Comments
 (0)