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

Comments

Projects
None yet
5 participants
@ollie27
Copy link
Contributor

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 A-rustbuild label Dec 12, 2016

@steveklabnik

This comment has been minimized.

Copy link
Member

steveklabnik commented Dec 12, 2016

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

This comment has been minimized.

Copy link
Member

alexcrichton commented Dec 12, 2016

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!

@bluss

This comment has been minimized.

Copy link
Contributor

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

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.
@ollie27

This comment has been minimized.

Copy link
Contributor 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

Auto merge of #38398 - ollie27:patch-1, r=alexcrichton
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.

bors added a commit that referenced this issue Dec 16, 2016

Auto merge of #38398 - ollie27:patch-1, r=alexcrichton
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

Rollup merge of rust-lang#38398 - ollie27:patch-1, r=alexcrichton
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 added a commit to alexcrichton/rust that referenced this issue Dec 20, 2016

Rollup merge of rust-lang#38398 - ollie27:patch-1, r=alexcrichton
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 added a commit to alexcrichton/rust that referenced this issue Dec 28, 2016

std: Don't build docs for misc facade crates
Retain the same behavior as stable.

Closes rust-lang#38319

alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 28, 2016

std: Don't build docs for misc facade crates
Retain the same behavior as stable.

Closes rust-lang#38319

bors added a commit that referenced this issue Dec 30, 2016

Auto merge of #38658 - alexcrichton:less-docs, r=nikomatsakis
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

std: Don't build docs for misc facade crates
Retain the same behavior as stable.

Closes rust-lang#38319

bors added a commit that referenced this issue Dec 30, 2016

Auto merge of #38658 - alexcrichton:less-docs, r=nikomatsakis
std: Don't build docs for misc facade crates

Retain the same behavior as stable.

Closes #38319

@bors bors closed this in #38658 Dec 30, 2016

alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 30, 2016

std: Don't build docs for misc facade crates
Retain the same behavior as stable.

Closes rust-lang#38319

alexcrichton added a commit to alexcrichton/rust that referenced this issue Dec 30, 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.
@ollie27

This comment has been minimized.

Copy link
Contributor 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

This comment has been minimized.

Copy link
Contributor

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

This comment has been minimized.

Copy link
Member

alexcrichton commented Jan 5, 2017

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 6, 2017

Auto merge of #38858 - ollie27:rustbuild_docs_std, r=alexcrichton
rustbuild: Stop building docs for std dependancies

Fixes: #38319

r? @alexcrichton

bors added a commit that referenced this issue Jan 6, 2017

Auto merge of #38858 - ollie27:rustbuild_docs_std, r=alexcrichton
rustbuild: Stop building docs for std dependancies

Fixes: #38319

r? @alexcrichton

bors added a commit that referenced this issue Jan 7, 2017

Auto merge of #38858 - ollie27:rustbuild_docs_std, r=alexcrichton
rustbuild: Stop building docs for std dependancies

Fixes: #38319

r? @alexcrichton

@bors bors closed this in #38858 Jan 7, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.