You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/doc/rustdoc/src/unstable-features.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -751,6 +751,22 @@ pass `--doctest-build-arg ARG` for each argument `ARG`.
751
751
752
752
This flag enables the generation of toggles to expand macros in the HTML source code pages.
753
753
754
+
## `--remap-path-prefix`: Remap source code paths in output
755
+
756
+
This flag is the equivalent flag from `rustc``--remap-path-prefix`.
757
+
758
+
it permits remapping source path prefixes in all output, including compiler diagnostics,
759
+
debug information, macro expansions, etc. It takes a value of the form `FROM=TO`
760
+
where a path prefix equal to `FROM` is rewritten to the value `TO`.
761
+
762
+
### `documentation` scope
763
+
764
+
`rustdoc` (and by extension `rustc`) have a special `documentation` remapping scope, it
765
+
permits remapping source paths that ends up in the generated documentation.
766
+
767
+
Currently the scope can only be specified from `rustc`, due to the lack of an equivalent
768
+
`--remap-path-scope` flag in `rustc`.
769
+
754
770
## `#[doc(cfg)]` and `#[doc(auto_cfg)]`
755
771
756
772
This feature aims at providing rustdoc users the possibility to add visual markers to the rendered documentation to know under which conditions an item is available (currently possible through the following unstable feature: `doc_cfg`).
0 commit comments