mk: don't build docs for internal or behind-the-facade crates #23848
Conversation
…/stable This saves a bunch of a time and will make distributions smaller, as well as avoiding filling the implementors page with internal garbage. Turn it back on with `--enable-compiler-docs` if you want compiler docs during development. Crates behind the facade are only documented on nightly/dev builds (where they can be used). [breaking-change] Closes #23772 Closes #21297
|
r? @huonw (rust_highfive has picked a reviewer for you, use r? to override) |
|
Doesn't this mean that |
|
@huonw Indeed not. I'll add a cfg for that (probably keying off whether the channel is stable/beta/nightly) |
| @@ -526,7 +526,8 @@ VAL_OPTIONS="" | |||
| opt valgrind 0 "run tests with valgrind (memcheck by default)" | |||
| opt helgrind 0 "run tests with helgrind instead of memcheck" | |||
| opt valgrind-rpass 1 "run rpass-valgrind tests with valgrind" | |||
| opt docs 1 "build documentation" | |||
| opt docs 1 "build standard libraary documentation" | |||
|
r=me with minor nits. |
|
@bors: r=huonw rollup |
|
📌 Commit e64b677 has been approved by |
|
🎊 |
|
Hm, was it considered that most |
This saves a bunch of a time and will make distributions smaller, as well as avoiding filling the implementors page with internal garbage. Turn it back on with `--enable-compiler-docs` if you want them. (Crates behind the facade are not documented at all) [breaking-change]
|
@alexcrichton That is quite unfortunate... |
|
Ahhh |
|
Actually on second thought this also breaks all cross-crate links to I think that these two downsides are pretty serious, @cmr would you be ok reverting the "don't build docs for facade crates" part of this PR? |
|
@alexcrichton yeah, I'll back that bit out. |
|
Ok, thanks @cmr! |
|
This broke so many links in documentation: #14515 (comment) |
|
@steveklabnik what docs link to compiler crates? |
|
We have an 'unstable' section of the book, and one of the chapters documents syntax extensions. |
This saves a bunch of a time and will make distributions smaller, as well as
avoiding filling the implementors page with internal garbage. Turn it back on
with
--enable-compiler-docsif you want them.(Crates behind the facade are not documented at all)
[breaking-change]