-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Rename rustc guide #69747
Rename rustc guide #69747
Conversation
cc @rust-lang/wg-learning |
bd0fd2a
to
08119a3
Compare
.gitmodules
Outdated
url = https://github.com/rust-lang/rustc-guide.git | ||
[submodule "src/doc/rustc-dev-guide"] | ||
path = src/doc/rustc-dev-guide | ||
url = https://github.com/rust-lang/rustc-dev-guide.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this change handled gracefully by our build system or do I need to change something else? cc @Mark-Simulacrum
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine. But perhaps also git mv to rename the directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should update the submodule after the rename. As soon as we do I can fix this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this should be fine, though I'm personally uncertain whether something else needs to change (i.e., our tooling should be fine but I don't know what git'll want).
Your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem. Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, haven't spotted any mistake.
@@ -434,7 +434,7 @@ For people new to Rust, and just starting to contribute, or even for | |||
more seasoned developers, some useful places to look for information | |||
are: | |||
|
|||
* The [rustc guide] contains information about how various parts of the compiler work and how to contribute to the compiler | |||
* The [rustc dev guide] contains information about how various parts of the compiler work and how to contribute to the compiler |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes me wonder if we should decide whether to use rustc-dev-guide
or rustc dev guide
and stick to one of them, or if it is completely insignificant
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well I was just naively translating things, unsure if it's significant but I guess we can discuss on a separate PR.
@@ -3,7 +3,7 @@ The `rustc_ast` crate contains those things concerned purely with syntax | |||
lexer, macro expander, and utilities for traversing ASTs. | |||
|
|||
For more information about how these things work in rustc, see the | |||
rustc guide: | |||
rustc dev guide: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add an active link here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should, but maybe let's handle that on a separate PR?
Your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem. Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
36003a2 includes clippy sudmodule, we should drop it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly looks good to me, but it looks like you accidentally updated the clippy submodule.
36003a2
to
005980e
Compare
Seems like the repo was dirty because the command I was running doesn't include submodules. Anyway, fixed thanks for pointing that out. |
Your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem. Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now!
Actually, we have to rename the repo actually to r+, let's hold off on at this point. |
Yeah, this one is not ready. I thought I was changing rustc-guide :P. We need to first rename the repo. |
This should be now, ready to merge |
r=me on behalf of the WG once CI is happy. |
Ah, it seems the previous submodule remains: https://github.com/rust-lang/rust/tree/f4445da203ca08659f513a841f13cbfbb22b460b/src/doc |
fixed! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
f29e78c
to
b172007
Compare
b172007
to
b3b32b7
Compare
r=me once CI passes. |
@bors r+ rollup |
📌 Commit b3b32b7 has been approved by |
🌲 The tree is currently closed for pull requests below priority 1000, this pull request will be tested once the tree is reopened |
…etroalbini Rename rustc guide This is in preparation for rust-lang/rustc-dev-guide#470 Needs to be merged after we actually rename the guide. Have used this to rename: `git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'` `git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'` `git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'`
…etroalbini Rename rustc guide This is in preparation for rust-lang/rustc-dev-guide#470 Needs to be merged after we actually rename the guide. Have used this to rename: `git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'` `git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'` `git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'`
Rollup of 10 pull requests Successful merges: - #68899 (Add Display and Error impls for proc_macro::LexError) - #69011 (Document unsafe blocks in core::fmt) - #69674 (Rename DefKind::Method and TraitItemKind::Method ) - #69705 (Toolstate: remove redundant beta-week check.) - #69722 (Tweak output for invalid negative impl AST errors) - #69747 (Rename rustc guide) - #69792 (Implement Error for TryReserveError) - #69830 (miri: ICE on invalid terminators) - #69921 (rustdoc: remove unused import) - #69945 (update outdated comment) Failed merges: r? @ghost
This is in preparation for rust-lang/rustc-dev-guide#470
Needs to be merged after we actually rename the guide.
Have used this to rename:
git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'
git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'
git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'