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.

Sign up for GitHub

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

Jump to bottom

rustc_macros is not in rustc API docs #80345

Closed
camelid opened this issue Dec 24, 2020 · 2 comments · Fixed by #80362
Closed

rustc_macros is not in rustc API docs #80345

camelid opened this issue Dec 24, 2020 · 2 comments · Fixed by #80362
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Dec 24, 2020 •
edited
Loading

Maybe because it's a proc-macro crate? It's not on the crate index list, nor is it in the search index, and https://doc.rust-lang.org/nightly/nightly-rustc/rustc_macros doesn't exist.
@camelid camelid added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) C-bug Category: This is a bug. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Dec 24, 2020
@ehuss
Copy link
Contributor

ehuss commented Dec 24, 2020

Proc-macro documentation is stored in a different directory when --target is used. There is a little more discussion of this at rust-lang/cargo#7677. It is not clear how feasible that is to fix.

@jyn514
Copy link
Member

jyn514 commented Dec 24, 2020

Bootstrap can work around this the same way docs.rs does, by moving compiler-doc/x86_64-unknown-linux-gnu/rustc_macros to compiler-doc/rustc_macros manually.

@jyn514 jyn514 mentioned this issue Dec 25, 2020
Merged
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Dec 28, 2020
@Dylan-DPC
Rollup merge of rust-lang#80362 - jyn514:rustc-macros, r=ehuss
cc579a1 
Document rustc_macros on nightly-rustc

Fixes rust-lang#80345.

![image](https://user-images.githubusercontent.com/23638587/103113442-b7ba2d00-4628-11eb-8a4d-c542f2d170e1.png)
![image](https://user-images.githubusercontent.com/23638587/103113448-bc7ee100-4628-11eb-8657-2d72e88de656.png)

r? `@ehuss`
@bors bors closed this as completed in 18be436 Dec 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document rustc_macros on nightly-rustc jyn514/rust
3 participants
@ehuss @jyn514 @camelid