Skip to content

Commit 3530a26

Browse files
committed
docs(unstable): explain -Z rustdoc-depinfo
1 parent 95dafab commit 3530a26

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/doc/src/reference/unstable.md

+9
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ Each new feature described below should explain how to use it.
9898
* [rustdoc-map](#rustdoc-map) --- Provides mappings for documentation to link to external sites like [docs.rs](https://docs.rs/).
9999
* [scrape-examples](#scrape-examples) --- Shows examples within documentation.
100100
* [output-format](#output-format-for-rustdoc) --- Allows documentation to also be emitted in the experimental [JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/).
101+
* [rustdoc-depinfo](#rustdoc-depinfo) --- Use dep-info files in rustdoc rebuild detection.
101102
* `Cargo.toml` extensions
102103
* [Profile `rustflags` option](#profile-rustflags-option) --- Passed directly to rustc.
103104
* [codegen-backend](#codegen-backend) --- Select the codegen backend used by rustc.
@@ -1901,6 +1902,14 @@ Requires `-Zunstable-options`.
19011902
See [`cargo package --message-format`](../commands/cargo-package.md#option-cargo-package---message-format)
19021903
for more information.
19031904

1905+
## rustdoc depinfo
1906+
1907+
* Tracking Issue: [#00000](https://github.com/rust-lang/cargo/issues/00000)
1908+
1909+
The `-Z rustdoc-depinfo` flag leverages rustdoc's dep-info files to determine
1910+
whether documentations are required to re-generate. This can be combined with
1911+
`-Z checksum-freshness` to detect checksum changes rather than file mtime.
1912+
19041913
# Stabilized and removed features
19051914

19061915
## Compile progress

0 commit comments

Comments
 (0)