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

Make it easier to not download docs at all. #24117

Closed
brson opened this issue Apr 6, 2015 · 6 comments
Closed

Make it easier to not download docs at all. #24117

brson opened this issue Apr 6, 2015 · 6 comments
Labels
P-medium Medium priority

Comments

@brson
Copy link
Contributor

brson commented Apr 6, 2015

The 'rust' package includes docs, which take up a bunch of room, slowing the download. Some people don't want docs, and downloading is a waste.

Problem here is that it's now impossible for tools like rustup/multirust to determine which version of cargo to pair with each revision of rust. Secondary problem is that the archive date for rustc/cargo packages may be different from the archive date of the rust package, so one may not get the toolchain they were expecting.

One possible (probably easiest) solution is to add an 'online' installer, that doesn't actually include the bins, but knows where the components live. This can be added to rust-installer.

cc brson/multirust#33

@nagisa
Copy link
Member

nagisa commented Apr 9, 2015

gzipped documentation takes up only about 7MB of the package. With xz (see #21724) it is an essentially free 3MB. Might not be worth having separate doc-less artefacts.

@steveklabnik
Copy link
Member

Triage: no change.

Personal note: as @nagisa says, it's very small, and offline docs are quite useful. Lots of people ask about "how do i install the docs locally" on IRC, I would prefer to just keep them.

@nagisa
Copy link
Member

nagisa commented May 24, 2016

I think this is essentially resolved. We distribute rustc, rust-std and rust-docs packages, which in most cases should be preferred to the one-big-bundle packages anyway.

@brson
Copy link
Contributor Author

brson commented Aug 22, 2016

With the rustup component subcommand we can make the docs an optional package in the manifests.

@japaric
Copy link
Member

japaric commented Nov 18, 2016

@alexcrichton
Copy link
Member

Closing due to @japaric's last comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P-medium Medium priority
Projects
None yet
Development

No branches or pull requests

5 participants