Rename rustc guide #69747

spastorino · 2020-03-05T21:09:10Z

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'

mark-i-m · 2020-03-05T22:18:20Z

cc @rust-lang/wg-learning

spastorino · 2020-03-06T14:20:49Z

.gitmodules

-	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


Is this change handled gracefully by our build system or do I need to change something else? cc @Mark-Simulacrum

I think it's fine. But perhaps also git mv to rename the directory.

We should update the submodule after the rename. As soon as we do I can fix this PR.

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).

rust-highfive · 2020-03-06T14:21:06Z

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.

2020-03-06T14:17:57.8890968Z ========================== Starting Command Output ===========================
2020-03-06T14:17:57.8896480Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/6c373c06-869a-440e-95ff-5a14f3028eab.sh
2020-03-06T14:17:57.8896992Z 
2020-03-06T14:17:57.8901721Z ##[section]Finishing: Disable git automatic line ending conversion
2020-03-06T14:17:57.8922818Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69747/merge to s
2020-03-06T14:17:57.8926433Z Task         : Get sources
2020-03-06T14:17:57.8926764Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-06T14:17:57.8927099Z Version      : 1.0.0
2020-03-06T14:17:57.8927317Z Author       : Microsoft
---
2020-03-06T14:17:59.4953557Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-03-06T14:17:59.4960623Z ##[command]git config gc.auto 0
2020-03-06T14:17:59.4965329Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-03-06T14:17:59.4969273Z ##[command]git config --get-all http.proxy
2020-03-06T14:17:59.4978120Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/69747/merge:refs/remotes/pull/69747/merge

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 @rust-lang/infra. (Feature Requests)

LeSeulArtichaut

Looks good to me, haven't spotted any mistake.

LeSeulArtichaut · 2020-03-06T21:46:03Z

CONTRIBUTING.md

@@ -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


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

well I was just naively translating things, unsure if it's significant but I guess we can discuss on a separate PR.

LeSeulArtichaut · 2020-03-06T21:48:57Z

src/librustc_ast/README.md

@@ -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:


Maybe add an active link here?

I think we should, but maybe let's handle that on a separate PR?

rust-highfive · 2020-03-09T21:22:17Z

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.

2020-03-09T21:20:32.7158765Z Prepare build directory.
2020-03-09T21:20:32.7523171Z Set build variables.
2020-03-09T21:20:32.7560771Z Download all required tasks.
2020-03-09T21:20:32.7699288Z Downloading task: Bash (3.163.1)
2020-03-09T21:20:33.7266086Z Checking job knob settings.
2020-03-09T21:20:33.7289905Z Finished checking job knob settings.
2020-03-09T21:20:33.7898932Z ##[section]Finishing: Initialize job
2020-03-09T21:20:33.8268591Z ##[section]Starting: Configure Job Name
2020-03-09T21:20:33.8502645Z ==============================================================================
2020-03-09T21:20:33.8503437Z Task         : Bash
---
2020-03-09T21:20:35.1747156Z ========================== Starting Command Output ===========================
2020-03-09T21:20:35.1750466Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/2e558ba0-15b9-4feb-9a4f-b56cea4576d3.sh
2020-03-09T21:20:35.1750963Z 
2020-03-09T21:20:35.1755895Z ##[section]Finishing: Disable git automatic line ending conversion
2020-03-09T21:20:35.1775641Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69747/merge to s
2020-03-09T21:20:35.1779090Z Task         : Get sources
2020-03-09T21:20:35.1779506Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-09T21:20:35.1779797Z Version      : 1.0.0
2020-03-09T21:20:35.1779995Z Author       : Microsoft
---
2020-03-09T21:20:36.1707927Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-03-09T21:20:36.1713702Z ##[command]git config gc.auto 0
2020-03-09T21:20:36.1717401Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-03-09T21:20:36.1720784Z ##[command]git config --get-all http.proxy
2020-03-09T21:20:36.1727028Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/69747/merge:refs/remotes/pull/69747/merge

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 @rust-lang/infra. (Feature Requests)

JohnTitor · 2020-03-09T21:27:41Z

36003a2 includes clippy sudmodule, we should drop it.

mark-i-m

Mostly looks good to me, but it looks like you accidentally updated the clippy submodule.

spastorino · 2020-03-09T21:34:21Z

Seems like the repo was dirty because the command I was running doesn't include submodules. Anyway, fixed thanks for pointing that out.

rust-highfive · 2020-03-09T21:36:22Z

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.

2020-03-09T21:33:49.8521386Z Prepare build directory.
2020-03-09T21:33:49.8855236Z Set build variables.
2020-03-09T21:33:49.8889216Z Download all required tasks.
2020-03-09T21:33:49.9010025Z Downloading task: Bash (3.163.1)
2020-03-09T21:33:50.9701833Z Checking job knob settings.
2020-03-09T21:33:50.9724271Z Finished checking job knob settings.
2020-03-09T21:33:51.0357197Z ##[section]Finishing: Initialize job
2020-03-09T21:33:51.0696557Z ##[section]Starting: Configure Job Name
2020-03-09T21:33:51.0898876Z ==============================================================================
2020-03-09T21:33:51.0899623Z Task         : Bash
---
2020-03-09T21:33:52.4222767Z ========================== Starting Command Output ===========================
2020-03-09T21:33:52.4225545Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/c7330566-4616-4dbd-ae9f-516df2491ff9.sh
2020-03-09T21:33:52.4225804Z 
2020-03-09T21:33:52.4230880Z ##[section]Finishing: Disable git automatic line ending conversion
2020-03-09T21:33:52.4248977Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69747/merge to s
2020-03-09T21:33:52.4252360Z Task         : Get sources
2020-03-09T21:33:52.4252619Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-09T21:33:52.4252902Z Version      : 1.0.0
2020-03-09T21:33:52.4253072Z Author       : Microsoft
---
2020-03-09T21:33:53.4345742Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-03-09T21:33:53.4352962Z ##[command]git config gc.auto 0
2020-03-09T21:33:53.4357321Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-03-09T21:33:53.4360777Z ##[command]git config --get-all http.proxy
2020-03-09T21:33:53.4367680Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/69747/merge:refs/remotes/pull/69747/merge

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 @rust-lang/infra. (Feature Requests)

mark-i-m

Looks good now!

JohnTitor · 2020-03-09T22:12:34Z

Actually, we have to rename the repo actually to r+, let's hold off on at this point.
r? @JohnTitor

spastorino · 2020-03-09T22:18:29Z

Yeah, this one is not ready. I thought I was changing rustc-guide :P. We need to first rename the repo.

spastorino · 2020-03-10T14:07:29Z

This should be now, ready to merge

JohnTitor · 2020-03-10T14:11:14Z

r=me on behalf of the WG once CI is happy.

JohnTitor · 2020-03-10T14:16:38Z

Ah, it seems the previous submodule remains: https://github.com/rust-lang/rust/tree/f4445da203ca08659f513a841f13cbfbb22b460b/src/doc

spastorino · 2020-03-10T14:18:55Z

fixed!

mark-i-m

LGTM

rust-highfive · 2020-03-10T16:18:00Z

The job mingw-check of 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.

2020-03-10T14:19:50.6483950Z ========================== Starting Command Output ===========================
2020-03-10T14:19:50.6486737Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/304d695e-1273-448f-9553-992ee628b7c6.sh
2020-03-10T14:19:50.6486983Z 
2020-03-10T14:19:50.6491339Z ##[section]Finishing: Disable git automatic line ending conversion
2020-03-10T14:19:50.6510430Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69747/merge to s
2020-03-10T14:19:50.6513659Z Task         : Get sources
2020-03-10T14:19:50.6513929Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-10T14:19:50.6514188Z Version      : 1.0.0
2020-03-10T14:19:50.6514429Z Author       : Microsoft
---
2020-03-10T14:19:51.8160851Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-03-10T14:19:51.8170160Z ##[command]git config gc.auto 0
2020-03-10T14:19:51.8178122Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-03-10T14:19:51.8184390Z ##[command]git config --get-all http.proxy
2020-03-10T14:19:51.8196533Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/69747/merge:refs/remotes/pull/69747/merge
---
2020-03-10T14:28:28.2763082Z configure: build.locked-deps    := True
2020-03-10T14:28:28.2763379Z configure: llvm.ccache          := sccache
2020-03-10T14:28:28.2763848Z configure: build.cargo-native-static := True
2020-03-10T14:28:28.2764303Z configure: dist.missing-tools   := True
2020-03-10T14:28:28.2764894Z configure: build.configure-args := ['--enable-sccache', '--disable-manage-submodu ...
2020-03-10T14:28:28.2765416Z configure: writing `config.toml` in current directory
2020-03-10T14:28:28.2765658Z configure: 
2020-03-10T14:28:28.2766051Z configure: run `python /checkout/x.py --help`
2020-03-10T14:28:28.2766265Z configure: 
---
2020-03-10T14:36:00.3399103Z Build completed successfully in 0:00:43
2020-03-10T14:36:00.3409015Z + /scripts/validate-toolstate.sh
2020-03-10T14:36:00.3458977Z Cloning into 'rust-toolstate'...
2020-03-10T14:36:01.0332278Z Traceback (most recent call last):
2020-03-10T14:36:01.0332659Z   File "../../src/tools/publish_toolstate.py", line 307, in <module>
2020-03-10T14:36:01.0332967Z     cur_datetime
2020-03-10T14:36:01.0333232Z   File "../../src/tools/publish_toolstate.py", line 207, in update_latest
2020-03-10T14:36:01.0334493Z     maintainers = ' '.join('@'+name for name in MAINTAINERS[tool])
2020-03-10T14:36:01.0334976Z KeyError: u'rustc-guide'
2020-03-10T14:36:01.0384060Z   local time: Tue Mar 10 14:36:01 UTC 2020
2020-03-10T14:36:01.3265433Z   network time: Tue, 10 Mar 2020 14:36:01 GMT
2020-03-10T14:36:01.3265728Z == end clock drift check ==
2020-03-10T14:36:02.0944975Z 
2020-03-10T14:36:02.0944975Z 
2020-03-10T14:36:02.1026810Z ##[error]Bash exited with code '1'.
2020-03-10T14:36:02.1041706Z ##[section]Finishing: Run build
2020-03-10T14:36:02.1092484Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69747/merge to s
2020-03-10T14:36:02.1097275Z Task         : Get sources
2020-03-10T14:36:02.1097593Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-10T14:36:02.1097903Z Version      : 1.0.0
2020-03-10T14:36:02.1098107Z Author       : Microsoft
2020-03-10T14:36:02.1098107Z Author       : Microsoft
2020-03-10T14:36:02.1098437Z Help         : [More Information](https://go.microsoft.com/fwlink/?LinkId=798199)
2020-03-10T14:36:02.1098830Z ==============================================================================
2020-03-10T14:36:02.4485157Z Cleaning any cached credential from repository: rust-lang/rust (GitHub)
2020-03-10T14:36:02.4527596Z ##[section]Finishing: Checkout rust-lang/rust@refs/pull/69747/merge to s
2020-03-10T14:36:02.4621988Z Cleaning up task key
2020-03-10T14:36:02.4623152Z Start cleaning up orphan processes.
2020-03-10T14:36:02.4808693Z Terminate orphan process: pid (3783) (python)
2020-03-10T14:36:02.5052810Z ##[section]Finishing: Finalize Job

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 @rust-lang/infra. (Feature Requests)

spastorino · 2020-03-10T20:10:18Z

r? @pietroalbini

pietroalbini · 2020-03-10T20:13:32Z

r=me once CI passes.

pietroalbini · 2020-03-10T23:00:24Z

@bors r+ rollup

bors · 2020-03-10T23:00:25Z

📌 Commit b3b32b7 has been approved by pietroalbini

bors · 2020-03-10T23:00:26Z

🌲 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'`

@ghost

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

rust-highfive assigned cramertj Mar 5, 2020

chrissimpkins mentioned this pull request Mar 6, 2020

rustc-guide to rustc-dev-guide transition rust-lang/rustc-dev-guide#602

Closed

28 tasks

JohnTitor unassigned cramertj Mar 6, 2020

JohnTitor added the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Mar 6, 2020

spastorino force-pushed the rename-rustc-guide branch from bd0fd2a to 08119a3 Compare March 6, 2020 14:14

spastorino commented Mar 6, 2020

View reviewed changes

LeSeulArtichaut approved these changes Mar 6, 2020

View reviewed changes

mark-i-m suggested changes Mar 9, 2020

View reviewed changes

spastorino force-pushed the rename-rustc-guide branch from 36003a2 to 005980e Compare March 9, 2020 21:33

mark-i-m approved these changes Mar 9, 2020

View reviewed changes

spastorino changed the title ~~[Do not merge yet] Rename rustc guide~~ Rename rustc guide Mar 9, 2020

spastorino marked this pull request as ready for review March 9, 2020 22:00

rust-highfive assigned JohnTitor Mar 9, 2020

spastorino changed the title ~~Rename rustc guide~~ [WIP] Rename rustc guide Mar 9, 2020

spastorino changed the title ~~[WIP] Rename rustc guide~~ Rename rustc guide Mar 10, 2020

JohnTitor added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Mar 10, 2020

mark-i-m approved these changes Mar 10, 2020

View reviewed changes

spastorino force-pushed the rename-rustc-guide branch from f29e78c to b172007 Compare March 10, 2020 20:04

spastorino added 5 commits March 10, 2020 17:08

Rename rustc-guide to rustc-dev-guide

0037f4e

Rename rustc guide to rustc dev guide

9d4fdba

Rename rustc_guide to rustc_dev_guide

1ddcea3

Rename Rustc Guide to Rustc Dev Guide

d00b269

rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org

b3b32b7

spastorino force-pushed the rename-rustc-guide branch from b172007 to b3b32b7 Compare March 10, 2020 20:08

rust-highfive assigned pietroalbini and unassigned JohnTitor Mar 10, 2020

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-review Status: Awaiting review from the assignee but also interested parties. labels Mar 10, 2020

Centril mentioned this pull request Mar 11, 2020

Rollup of 8 pull requests #69927

Closed

Centril mentioned this pull request Mar 11, 2020

Rollup of 9 pull requests #69931

Closed

Centril mentioned this pull request Mar 12, 2020

Rollup of 10 pull requests #69950

Merged

bors merged commit 39c6405 into rust-lang:master Mar 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename rustc guide #69747

Rename rustc guide #69747

spastorino commented Mar 5, 2020 •

edited

Loading

mark-i-m commented Mar 5, 2020

spastorino Mar 6, 2020

mark-i-m Mar 6, 2020

spastorino Mar 6, 2020

Mark-Simulacrum Mar 10, 2020

rust-highfive commented Mar 6, 2020

LeSeulArtichaut left a comment

LeSeulArtichaut Mar 6, 2020

spastorino Mar 9, 2020

LeSeulArtichaut Mar 6, 2020

spastorino Mar 9, 2020

rust-highfive commented Mar 9, 2020

JohnTitor commented Mar 9, 2020

mark-i-m left a comment

spastorino commented Mar 9, 2020

rust-highfive commented Mar 9, 2020

mark-i-m left a comment

JohnTitor commented Mar 9, 2020

spastorino commented Mar 9, 2020

spastorino commented Mar 10, 2020

JohnTitor commented Mar 10, 2020

JohnTitor commented Mar 10, 2020

spastorino commented Mar 10, 2020

mark-i-m left a comment

rust-highfive commented Mar 10, 2020

spastorino commented Mar 10, 2020

pietroalbini commented Mar 10, 2020

pietroalbini commented Mar 10, 2020

bors commented Mar 10, 2020

bors commented Mar 10, 2020

Rename rustc guide #69747

Rename rustc guide #69747

Conversation

spastorino commented Mar 5, 2020 • edited Loading

mark-i-m commented Mar 5, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rust-highfive commented Mar 6, 2020

LeSeulArtichaut left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rust-highfive commented Mar 9, 2020

JohnTitor commented Mar 9, 2020

mark-i-m left a comment

Choose a reason for hiding this comment

spastorino commented Mar 9, 2020

rust-highfive commented Mar 9, 2020

mark-i-m left a comment

Choose a reason for hiding this comment

JohnTitor commented Mar 9, 2020

spastorino commented Mar 9, 2020

spastorino commented Mar 10, 2020

JohnTitor commented Mar 10, 2020

JohnTitor commented Mar 10, 2020

spastorino commented Mar 10, 2020

mark-i-m left a comment

Choose a reason for hiding this comment

rust-highfive commented Mar 10, 2020

spastorino commented Mar 10, 2020

pietroalbini commented Mar 10, 2020

pietroalbini commented Mar 10, 2020

bors commented Mar 10, 2020

bors commented Mar 10, 2020

spastorino commented Mar 5, 2020 •

edited

Loading