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

Consider if we want to bundle rustc source code in docs #23061

Closed
lifthrasiir opened this issue Mar 5, 2015 · 7 comments
Closed

Consider if we want to bundle rustc source code in docs #23061

lifthrasiir opened this issue Mar 5, 2015 · 7 comments

Comments

@lifthrasiir
Copy link
Contributor

Currently generated doc/src directory is 26MB without compiler docs and 48MB with them. This becomes the largest directory inside generated docs once #23060 lands (doc/rustc is over 90MB before that patch, for the reference). It will also interfere with #2206, as we would no longer have source codes to dump.

It takes about 5MB in the gzipped tarball, so this is not negligible size. We can instead link to the source code in static.rust-lang.org or, possibly, Github with a permalink.

@kmcallister kmcallister changed the title Consider if we want to bundle source codes in generated docs Consider if we want to bundle rustc source code in docs Mar 5, 2015
@steveklabnik
Copy link
Member

It's also useful for plugins like Racer.

@lifthrasiir
Copy link
Contributor Author

@steveklabnik But only if we have raw source code, right? I don't think Racer can consume HTMLized source code files.

@steveklabnik
Copy link
Member

That's what I thought the title was talking about: 'rustc source code'

@lifthrasiir
Copy link
Contributor Author

Ugh, I think @kmcallister has misunderstood the issue ;) I meant the source code linked from the [src] button, which might or might not be useful. We can, as a middle ground, make it optional and link to doc.rust-lang.org when unavailable.

@kmcallister
Copy link
Contributor

I meant the source code linked from the [src] button

Yes, that's what I meant as well. Feel free to change the title again if you think it's unclear.

@steveklabnik
Copy link
Member

Traige: I thought @brson had an issue on rustup.rs for this, but could not find it.

@brson
Copy link
Contributor

brson commented Jun 9, 2016

It looks to me like there has been confusion on what this issue is even about. This is quite an old issue, and it originally appears to be discussing whether the compiler sources (not std) are included with the docs, assuming that the compiler API docs are even included with the docs (which they no longer are).

I'd suggest that since we don't actually distribute the compiler docs at all, this entire issue is subsumed by #29893 (distribute the compiler docs). Also related to #19535 (package source code).

@brson brson closed this as completed Jun 9, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants