Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustbuild builds docs for too many crates #38319

Closed
ollie27 opened this issue Dec 12, 2016 · 7 comments
Closed

rustbuild builds docs for too many crates #38319

ollie27 opened this issue Dec 12, 2016 · 7 comments
Assignees
Labels
P-high High priority regression-from-stable-to-beta Performance or correctness regression from stable to beta. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@ollie27
Copy link
Member

ollie27 commented Dec 12, 2016

The Makefiles only build the docs for:

std
alloc
collections
core
libc
rustc_unicode

I assume alloc, collections and rustc_unicode are included mostly so the src links in std work. I'm not sure why libc is included though...

Anyway, with rustbuild it builds all of these:

core
compiler_builtins
rand
libc
rustc_unicode
alloc
unwind
panic_abort
alloc_system
panic_unwind
collections
std
std_shim

getopts
term
test
test_shim

Most of these are implementation details of std so shouldn't be included. The test docs are a big problem because of the same issue as #34800, generating them means the search index will get overridden.

@bluss bluss added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Dec 12, 2016
@steveklabnik
Copy link
Member

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.

@alexcrichton
Copy link
Member

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 alexcrichton added regression-from-stable-to-nightly Performance or correctness regression from stable to nightly. T-tools labels Dec 12, 2016
@brson brson assigned alexcrichton and unassigned alexcrichton Dec 15, 2016
@brson brson added the P-high High priority label Dec 15, 2016
@bluss
Copy link
Member

bluss commented Dec 15, 2016

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
They cause the search index from the std docs to get overwritten just like rust-lang#34800.

Part of rust-lang#38319.
@ollie27
Copy link
Member Author

ollie27 commented Dec 15, 2016

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
rustbuild: Stop building docs for libtest by default

They cause the search index from the std docs to get overwritten just like #34800.

Part of #38319.
alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 20, 2016
rustbuild: Stop building docs for libtest by default

They cause the search index from the std docs to get overwritten just like rust-lang#34800.

Part of rust-lang#38319.
@alexcrichton alexcrichton added regression-from-stable-to-beta Performance or correctness regression from stable to beta. and removed regression-from-stable-to-nightly Performance or correctness regression from stable to nightly. labels Dec 29, 2016
alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 30, 2016
Retain the same behavior as stable.

Closes rust-lang#38319
bors added a commit that referenced this issue Dec 30, 2016
std: Don't build docs for misc facade crates

Retain the same behavior as stable.

Closes #38319
alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 30, 2016
Retain the same behavior as stable.

Closes rust-lang#38319
alexcrichton pushed a commit to alexcrichton/rust that referenced this issue Dec 30, 2016
They cause the search index from the std docs to get overwritten just like rust-lang#34800.

Part of rust-lang#38319.
@ollie27
Copy link
Member Author

ollie27 commented Jan 5, 2017

This needs to be reopened. Unfortunately #38658 didn't work, it only disabled docs for std_shim.

@bluss bluss reopened this Jan 5, 2017
@bluss
Copy link
Member

bluss commented Jan 5, 2017

Still a stable → beta regression in the sense that the currently hosted beta rustdoc shows documentation for too many crates like for example alloc_system and unwind (and more).

@alexcrichton
Copy link
Member

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 -p std -p collections ... to explicitly whitelist crates we're documenting? We can worry about fixing the Cargo bug later.

bors added a commit that referenced this issue Jan 7, 2017
rustbuild: Stop building docs for std dependancies

Fixes: #38319

r? @alexcrichton
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P-high High priority regression-from-stable-to-beta Performance or correctness regression from stable to beta. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

No branches or pull requests

5 participants