Improve the guide #302
Open
Improve the guide #302
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LegNeato
requested changes
Nov 17, 2025
Contributor
LegNeato
left a comment
LegNeato
left a comment
There was a problem hiding this comment.
Jut some minor nits, thank you!
- Fix various typos, badly expressed sentences, etc. - Streamline the "The CUDA Pipeline" section, which is repetitive and contains a broken link to a non-existent image. - Remove reference to LLVM 12/13, which are now very old. - Tweak text about supporting CUDA versions; 12.x support is no longer experimental. - It's now `rust-toolchain.toml`, not `rust-toolchain`. And no need to include an out-of-date copy of it in the docs. - Remove a reference to `spirv_builder` which isn't that helpful. - Fix broken `Dockerfile` link.
Currently section 6 is empty and only has one subsection. So this commit moves the text in 6.1 into 6 and all of 6.1.n into 6.n. Also, there are two sections (`ptxgen.md` and `deuugging.md`) that are present but not shown because they aren't mentioned in `SUMMARY.md`. Include them.
- Use full names for `rustc_codegen_*` crates rather than shortened `cg_*` forms. - Streamline `rustc_codegen_ssa` description. - Minor grammer, punctuation, capitalization fixes. - Fix formatting of some lists.
nnethercote
force-pushed
the
improve-guide-1
branch
from
32994e8 to
16e45d0
Compare
Collaborator
Author
|
I fixed both nits, thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Rust CUDA Guide is in bad shape. There are a lot of potential improvements. This PR is just a start to fix some of the more obviously wrong/suboptimal things I encountered while reading it.