Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign uprustbuild builds docs for too many crates #38319
Comments
bluss
added
the
A-rustbuild
label
Dec 12, 2016
This comment has been minimized.
This comment has been minimized.
|
I'd say it's a bit more complex than that: we do want the ability to build these docs, but don't currently include them in the releases. |
This comment has been minimized.
This comment has been minimized.
|
I'm going to preemptively tag this as a regression as it'll soon become one. I suspect we can fix this by just disabling rustdoc in Cargo.toml for a bunch of crates. Should be an easy thing to knock out! |
alexcrichton
added
regression-from-stable-to-nightly
T-tools
labels
Dec 12, 2016
brson
assigned
alexcrichton
and unassigned
alexcrichton
Dec 15, 2016
brson
added
the
P-high
label
Dec 15, 2016
brson
assigned
alexcrichton
Dec 15, 2016
This comment has been minimized.
This comment has been minimized.
|
Nightly docs may show effect of this? Search index only contains getopts, term, test crates. See example: https://doc.rust-lang.org/nightly/std/index.html?search=Vec |
ollie27
added a commit
to ollie27/rust
that referenced
this issue
Dec 15, 2016
ollie27
referenced this issue
Dec 15, 2016
Merged
rustbuild: Stop building docs for libtest by default #38398
This comment has been minimized.
This comment has been minimized.
|
Yeah, I figured that might happen. I've submitted a small PR to fix that: #38398. |
bors
added a commit
that referenced
this issue
Dec 16, 2016
bors
added a commit
that referenced
this issue
Dec 16, 2016
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 20, 2016
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 20, 2016
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 28, 2016
alexcrichton
referenced this issue
Dec 28, 2016
Merged
std: Don't build docs for misc facade crates #38658
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 28, 2016
alexcrichton
added
regression-from-stable-to-beta
and removed
regression-from-stable-to-nightly
labels
Dec 29, 2016
bors
added a commit
that referenced
this issue
Dec 30, 2016
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 30, 2016
bors
added a commit
that referenced
this issue
Dec 30, 2016
bors
closed this
in
#38658
Dec 30, 2016
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 30, 2016
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Dec 30, 2016
This comment has been minimized.
This comment has been minimized.
|
This needs to be reopened. Unfortunately #38658 didn't work, it only disabled docs for |
bluss
reopened this
Jan 5, 2017
This comment has been minimized.
This comment has been minimized.
|
Still a stable → beta regression in the sense that the currently hosted beta rustdoc shows documentation for too many crates like for example |
This comment has been minimized.
This comment has been minimized.
|
Yes sorry @ollie27 I've been meaning to get around to reopening this. I suspect that there's a Cargo bug lurking here as to why we're building too much crate documentation. @ollie27 do you want to send a PR to just explicitly pass |
ollie27 commentedDec 12, 2016
The Makefiles only build the docs for:
I assume
alloc,collectionsandrustc_unicodeare included mostly so the src links instdwork. I'm not sure whylibcis included though...Anyway, with rustbuild it builds all of these:
Most of these are implementation details of
stdso shouldn't be included. Thetestdocs are a big problem because of the same issue as #34800, generating them means the search index will get overridden.