Skip to content
This repository has been archived by the owner on Nov 26, 2020. It is now read-only.

Host compiler documentation #40

Merged
merged 2 commits into from
Apr 2, 2018
Merged

Host compiler documentation #40

merged 2 commits into from
Apr 2, 2018

Conversation

davidtwco
Copy link
Member

This is the second half of rust-lang/rust#29893. The matching rust PR is rust-lang/rust#49193.

@davidtwco davidtwco changed the title Host compiler documentation WIP: Host compiler documentation Mar 20, 2018
@davidtwco
Copy link
Member Author

I've marked this as WIP as it hasn't been tested yet, until the matching Rust PR is merged and that produces tarballs, I'm not sure if it can.

@alexcrichton
Copy link
Member

This tentatively looks good, thanks! I'll take a closer look at rust-lang/rust#49193 now

bors added a commit to rust-lang/rust that referenced this pull request Mar 21, 2018
Host compiler documentation

Fixes #29893. Rust Central Station PR: rust-lang/rust-central-station#40

r? @alexcrichton
bors added a commit to rust-lang/rust that referenced this pull request Mar 21, 2018
Host compiler documentation

Fixes #29893. Rust Central Station PR: rust-lang/rust-central-station#40

r? @alexcrichton
bors added a commit to rust-lang/rust that referenced this pull request Mar 22, 2018
Host compiler documentation

Fixes #29893. Rust Central Station PR: rust-lang/rust-central-station#40

r? @alexcrichton
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Mar 23, 2018
alexcrichton added a commit to alexcrichton/rust that referenced this pull request Mar 23, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Mar 24, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Mar 24, 2018
@davidtwco davidtwco changed the title WIP: Host compiler documentation Host compiler documentation Mar 24, 2018
@davidtwco
Copy link
Member Author

Renamed this to remove the WIP since rust-lang/rust#49193 has landed and this can now be properly tested.

@alexcrichton
Copy link
Member

Ok great! One thing I actually realized though is that we'll want to gracefully handle the lack of a rustc-docs tarball as not all the stable/beta/nightly channels are currently producing one?

@davidtwco
Copy link
Member Author

@alexcrichton I've pushed a commit that adds a check for this.

@Michael-F-Bryan
Copy link

@davidtwco, does this mean we'll have a place to view the API docs for rustc internals once this PR lands? At the moment I'm using a rustc-internal-docs "script" to run ./x.py doc every night and upload the crate docs to GitHub Pages, but that's a pretty hacky solution and it looks like changes in x.py have broken it again (it no longer creates docs for librustc_driver and other internals).

@nikomatsakis, @mark-i-m, once this PR merges I believe rustc-guide should be able to link to the actual docs for various compiler internals (@davidtwco, feel free to correct me on this). It'd be much more useful to link to the rustdoc for structs/functions instead of the source code, and hopefully my mdbook-linkcheck will be able to detect broken links as things change.

@davidtwco
Copy link
Member Author

@Michael-F-Bryan If I'm not mistaken, they will be available at doc.rust-lang.org/nightly-rustc/<crate_name> (or something along those lines). I don't see any reason why you wouldn't be able to link to it.

@mark-i-m
Copy link
Member

@Michael-F-Bryan could you open an issue on rustc-guide to change the links?

@nikomatsakis
Copy link
Contributor

So excited for this. =)

@alexcrichton
Copy link
Member

Thanks @davidtwco! This looks great to me now. We've got a release in a few days so I'm gonna hold off on merging this until that's done, but I'll merge and test after that.

@Manishearth
Copy link
Member

(we've released!)

@alexcrichton alexcrichton merged commit 64230e0 into rust-lang:master Apr 2, 2018
@davidtwco davidtwco deleted the rust-lang/rust-issue-29893 branch April 2, 2018 16:19
@Michael-F-Bryan
Copy link

Awesome work @davidtwco and @alexcrichton!

Will the new internal API docs be available when the next nightly is released?

@alexcrichton
Copy link
Member

I've just now deployed this change to production, and yes hopefully after the next nightly we'll have shiny new docs!

@mark-i-m
Copy link
Member

mark-i-m commented Apr 2, 2018

Where will they be hosted? doc.rust-lang.org/nightly-rustc?

@alexcrichton
Copy link
Member

I believe it'll be doc.rust-lang.org/nightly/nightly-rustc

@mark-i-m
Copy link
Member

mark-i-m commented Apr 3, 2018

I'm guessing #43 means we will get this for tomorrow's nightly instead?

@davidtwco
Copy link
Member Author

@mark-i-m Yeah, sorry about that, it should work for tomorrow's nightly.

@alexcrichton
Copy link
Member

Documentation is now live!

@mark-i-m
Copy link
Member

mark-i-m commented Apr 4, 2018

@Manishearth
Copy link
Member

That's a private module

@mark-i-m
Copy link
Member

mark-i-m commented Apr 4, 2018

Oh, are they not documented? (EDIT: I guess this makes sense as a default, but still...) Would it be possible to generate documentation for them? It would be nice to be able to link to them from the rustc-guide, and they are actually useful for devs...

@Manishearth
Copy link
Member

Documenting private items for internals docs is being discussed here

@mark-i-m
Copy link
Member

mark-i-m commented Apr 4, 2018

Ah, great! Thanks @Manishearth :)

phansch added a commit to phansch/rustfmt that referenced this pull request Apr 19, 2018
Since rust-lang/rust-central-station#40 has been
merged, we have a stable location for the nightly docs.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants