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 missing links in platform support docs #94605

Merged
merged 2 commits into from
Apr 16, 2022
Merged

Conversation

Michcioperz
Copy link
Contributor

I was looking at m68k support and saw that https://doc.rust-lang.org/rustc/platform-support.html and the sidebar there were missing some links to target documentation

@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 @GuillaumeGomez (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 Mar 4, 2022
@GuillaumeGomez
Copy link
Member

Looks good to me, thanks! I'll let someone from the compiler team make the final approval.

r? @pnkfelix

- [armv7-unknown-linux-uclibceabi](platform-support/armv7-unknown-linux-uclibceabi.md)
- [armv7-unknown-linux-uclibceabihf](platform-support/armv7-unknown-linux-uclibceabihf.md)
- [aarch64-unknown-none-hermitkernel](platform-support/aarch64-unknown-none-hermitkernel.md)
- [\*-kmc-solid_\*](platform-support/kmc-solid.md)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- [\*-kmc-solid_\*](platform-support/kmc-solid.md)
- [*-kmc-solid_*](platform-support/kmc-solid.md)

It's not rendering them correctly with \ before the star.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tested it locally on mdBook 0.4.15 it doesn't seem to solve it. I tried a few more combinations and it seems that this works:

Suggested change
- [\*-kmc-solid_\*](platform-support/kmc-solid.md)
- [\*-kmc-solid_\\*](platform-support/kmc-solid.md)

as well as

Suggested change
- [\*-kmc-solid_\*](platform-support/kmc-solid.md)
- [\\*-kmc-solid_\*](platform-support/kmc-solid.md)

but I'm not seeing a working option with equal number of \ or no \ at all

Copy link
Member

Choose a reason for hiding this comment

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

@Michcioperz can you clarify whether one of the suggestions you have written here should be adopted?

Copy link
Contributor

@ehuss ehuss Apr 15, 2022

Choose a reason for hiding this comment

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

This is a bug with mdbook. I posted a fix at rust-lang/mdBook#1785. I recommend leaving it as the original [\*-kmc-solid_\*]. I'll publish a new version of mdbook soon and push a new PR here and that should fix the rendering.

@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
@pnkfelix
Copy link
Member

r=me once the author has resolved the question about the [\*-kmc-solid_\*] thing

@pnkfelix pnkfelix 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 Apr 14, 2022
@ehuss
Copy link
Contributor

ehuss commented Apr 15, 2022

Thanks! I'm going to go ahead and approve. The rendering issue should be resolved by #96088

@bors r=pnkfelix rollup

@bors
Copy link
Contributor

bors commented Apr 15, 2022

📌 Commit c1d5c2b has been approved by pnkfelix

@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 Apr 15, 2022
RalfJung added a commit to RalfJung/rust that referenced this pull request Apr 15, 2022
Add missing links in platform support docs

I was looking at m68k support and saw that https://doc.rust-lang.org/rustc/platform-support.html and the sidebar there were missing some links to target documentation
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Apr 15, 2022
Add missing links in platform support docs

I was looking at m68k support and saw that https://doc.rust-lang.org/rustc/platform-support.html and the sidebar there were missing some links to target documentation
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Apr 16, 2022
Add missing links in platform support docs

I was looking at m68k support and saw that https://doc.rust-lang.org/rustc/platform-support.html and the sidebar there were missing some links to target documentation
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 16, 2022
Rollup of 9 pull requests

Successful merges:

 - rust-lang#93969 (Only add codegen backend to dep info if -Zbinary-dep-depinfo is used)
 - rust-lang#94605 (Add missing links in platform support docs)
 - rust-lang#95372 (make unaligned_references lint deny-by-default)
 - rust-lang#95859 (Improve diagnostics for unterminated nested block comment)
 - rust-lang#95961 (implement SIMD gather/scatter via vector getelementptr)
 - rust-lang#96004 (Consider lifetimes when comparing types for equality in MIR validator)
 - rust-lang#96050 (Remove some now-dead code that was only relevant before deaggregation.)
 - rust-lang#96070 ([test] Add test cases for untested functions for BTreeMap)
 - rust-lang#96099 (MaybeUninit array cleanup)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6dd92bf into rust-lang:master Apr 16, 2022
@rustbot rustbot added this to the 1.62.0 milestone Apr 16, 2022
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants