rustdoc: follow-up work for --emit=toolchain-shared-resources
#83784
Labels
A-CLI
Area: Command-line interface (CLI) to the compiler
C-tracking-issue
Category: An issue tracking the progress of sth. like the implementation of an RFC
requires-nightly
This issue requires a nightly compiler in some way.
S-tracking-perma-unstable
Status: The feature will stay unstable indefinitely.
T-docs-rs
Relevant to the docs-rs subteam, which will review and decide on the PR/issue.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
This is a tracking issue for the unstable feature
--emit=toolchain-shared-resources
, which requires-Z unstable-options
. This feature is not meant to ever be stabilized; it's used by docs.rs to avoid copying the same files for each crate. Users other than docs.rs are not supported.Unresolved Questions
unversioned-shared-resources
completely? It's unclear what the difference between a versioned and unversioned resource is; I don't know if rustdoc can promise its files will never change even across toolchains.main.js
is currently marked as a toolchain resource, which is wrong if the user passes--theme
in RUSTDOCFLAGS.Implementation history
--print=unversioned-files
: Remove--print unversioned-files
from rustdoc #85770Why does this feature exist?
Docs.rs has been having quite a lot of trouble with essential files. Here are the recent developments:
--extern-html-root-url
(Docs for releases during 2018-{10-12} appear unstyled docs.rs#1327 (comment)). The tracking issue for rebuilding those is Docs built during 2018-{10-12} link to the wrong url for static resources docs.rs#1181.In summary, docs.rs can't copy fewer shared files than rustdoc generates, and due to 2 months of broken builds about 3 years ago, it also can't copy more. So there has to be a way to know exactly which files should be shared and which shouldn't.
The text was updated successfully, but these errors were encountered: