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

Publish docs for the proc_macro crate #39986

Closed
wants to merge 1 commit into from

Conversation

SimonSapin
Copy link
Contributor

Fix #38749

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@SimonSapin SimonSapin changed the title Publish docs for the proc_macros crate. Publish docs for the proc_macro crate Feb 20, 2017
@@ -162,7 +162,7 @@ pub fn std(build: &Build, stage: u32, target: &str) {
cargo.arg("-p").arg("std");
} else {
cargo.arg("--no-deps");
for krate in &["alloc", "collections", "core", "std", "std_unicode"] {
for krate in &["alloc", "collections", "core", "std", "std_unicode", "proc_macro"] {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be a const near the top of the file instead of a magic number / magic slice?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@est31
Copy link
Member

est31 commented Feb 20, 2017

I've tested it, it works!

@alexcrichton
Copy link
Member

I believe the cargo doc for proc-macro is going to have to be separated out because it has a separate tree of dependencies than the standard library. The "rustc crates" depend on the "test crates" which depend on the "std crates", and right now none of those are available when running cargo doc for std (as Cargo takes care of building the std crates).

To build docs for proc_macro we'd likely need to add a new step, add a dependency to building libtest, and then add a new function for generating the docs for proc_macro

(FWIW much of this I believe is evidenced from the current failure on Travis)

@SimonSapin
Copy link
Contributor Author

I made this PR as a drive-by on the assumption it was a one-line fix, but it sounds like it’ll require more time that I’m willing to spend on this.

So anyone feel free to take this over.

@alexcrichton
Copy link
Member

Ok, in that case I'll close this for now (to help clear out the queue), but we can always reopen if necessary

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

Successfully merging this pull request may close these issues.

5 participants