Add documentation entry for unstable --output-format flag

charmitro · charmitro · commit e8b305ecdbf9 · 2024-01-11T20:13:35.000+02:00
This is a follow-up to #12252. Signed-off-by: Charalampos Mitrodimas <charmitro@posteo.net>
diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md
@@ -89,6 +89,7 @@ For the latest nightly, see the [nightly version] of this page.
 * rustdoc
     * [rustdoc-map](#rustdoc-map) --- Provides mappings for documentation to link to external sites like [docs.rs](https://docs.rs/).
     * [scrape-examples](#scrape-examples) --- Shows examples within documentation.
+    * [output-format](#output-format) --- Allows documentation to also be emitted in the experimental [JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/).
 * `Cargo.toml` extensions
     * [Profile `rustflags` option](#profile-rustflags-option) --- Passed directly to rustc.
     * [codegen-backend](#codegen-backend) --- Select the codegen backend used by rustc.
@@ -1079,6 +1080,17 @@ If you want examples to be scraped from example targets, then you must not satis
 For example, you can set `doc-scrape-examples` to true for one example target, and that signals to Cargo that
 you are ok with dev-deps being build for `cargo doc`.
 
+## output-format
+
+* Tracking Issue: [#13283](https://github.com/rust-lang/cargo/issues/13283)
+
+This flag determines the output format of `cargo rustdoc`, accepting `html` or `json`, providing tools with a way to lean on [rustdoc's experimental JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/).
+
+You can use the flag like this:
+
+```
+cargo rustdoc -Z unstable-options --output-format json
+```
 
 ## check-cfg
 
