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

Add readable rustdoc display for RISC-V target #91518

Merged
merged 1 commit into from
May 11, 2022

Conversation

luojia65
Copy link
Contributor

@luojia65 luojia65 commented Dec 4, 2021

This pull request adds a human readable rustdoc display for RISC-V architecture. Target configuration marked as #[cfg(target_arch = "riscv32")] or #[cfg(target_arch = "riscv64")] are pretty formatted like RISC-V RV32 and RISC-V RV64 in Rust docs.

Before:

图片

After:

图片

@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 @ollie27 (or someone else) soon.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 4, 2021
@luojia65 luojia65 marked this pull request as ready for review December 5, 2021 08:24
@apiraino apiraino added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 9, 2021
@JohnCSimon JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 30, 2022
use format 'RISC-V RV32' and 'RISC-V RV64'
@luojia65
Copy link
Contributor Author

luojia65 commented Feb 6, 2022

Edit: after discussions with TUNA members the format used here are 'RISC-V RV32' and 'RISC-V RV64'. Now this pull request may be ready for review.

r? @ollie27

@camelid
Copy link
Member

camelid commented Mar 3, 2022

The idea of this change seems good to me, but I think the names should be RISC-V 32 and RISC-V 64. RISC-V RV32 seems repetitive to me.

@JohnCSimon JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 11, 2022
@JohnCSimon JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 8, 2022
@GuillaumeGomez
Copy link
Member

Any update on this @luojia65 ?

@GuillaumeGomez GuillaumeGomez added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 11, 2022
@luojia65
Copy link
Contributor Author

@GuillaumeGomez It's okay for me, no further updates :)

@GuillaumeGomez
Copy link
Member

Well, we can always update the text later on. Thanks!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented May 11, 2022

📌 Commit 39d99a1 has been approved by GuillaumeGomez

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 11, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request May 11, 2022
Rollup of 4 pull requests

Successful merges:

 - rust-lang#91518 (Add readable rustdoc display for RISC-V target)
 - rust-lang#95281 (Fix inaccurate function name in `rustc_const_eval` docs)
 - rust-lang#96898 (logging: add env var to control verbose scope entry/exit logging)
 - rust-lang#96936 (:arrow_up: rust-analyzer)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 2af6677 into rust-lang:master May 11, 2022
@rustbot rustbot added this to the 1.62.0 milestone May 11, 2022
@luojia65 luojia65 deleted the rustdoc-riscv-arch branch September 9, 2022 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants