Update post 2 with beginner friendly cargo tips #1234
Merged
Conversation
This file contains 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
As a relatively new person to Rust, I confused the `.cargo/config.toml` with the global cargo config in my home directory (`~/.cargo/config.toml). While this is pretty obviously wrong in hindsight, since I've never used the `[unstable]` options before, I didn't realize my mistake until this next thing that tripped me up. For `cargo install bootimage`, I think it is reasonable to tell the reader to go into a different directory to execute the command, since it might be the case that the reader has never dealt with different targets before and would have no idea that running `cargo install` for the new target that they just made in a json would be wrong (at least this was me). This could be worded differently than the changes I made, but I think that the addition of these could only benefit a confused reader.
phil-opp
reviewed
Aug 17, 2023
There was a problem hiding this comment.
Thanks a lot for the PR, these are some useful clarifications! The only thing that I'm not sure about is the blog_os prefix in the paths. We don't really use this convention anywhere else, so I fear that this might lead to some confusion too. For example, I could imagine that readers create a blog_os subdirectory within their project folder (which might have a different name).
|
Yeah I definitely agree, maybe the above change would make sense? I don't know if it is too wordy though. |
|
Maybe something like "the |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As a relatively new person to Rust, I confused the
.cargo/config.tomlwith the global cargo config in my home directory (~/.cargo/config.toml). While this is pretty obviously wrong in hindsight, since I've never used the[unstable]` options before, I didn't realize my mistake until this next thing that tripped me up.For
cargo install bootimage, I think it is reasonable to tell the reader to go into a different directory to execute the command, since it might be the case that the reader has never dealt with different targets before and would have no idea that runningcargo installfor the new target that they just made in a json would be wrong (at least this was me).This could be worded differently than the changes I made, but I think that the addition of these could only benefit a confused reader.
I'm new to PRs in general so apologies if I messed up something with the branches!