Skip to content

Start moving to the rustc guide! - #48479

Merged
bors merged 4 commits into
rust-lang:masterfrom
mark-i-m:rustc-guide
Feb 28, 2018
Merged

Start moving to the rustc guide!#48479
bors merged 4 commits into
rust-lang:masterfrom
mark-i-m:rustc-guide

Conversation

@mark-i-m

@mark-i-mmark-i-m commented Feb 23, 2018

Copy link
Copy Markdown
Contributor

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 23, 2018
nikomatsakis
nikomatsakis requested changes Feb 23, 2018
View reviewed changes

@nikomatsakisnikomatsakis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

r=me after that one nit

Comment threadsrc/librustc/README.md
@@ -1,204 +0,0 @@
An informal guide to reading and working on the rustc compiler.

@nikomatsakisnikomatsakisFeb 23, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you replace this with a README -- or maybe doc-comment on the crate -- that says to see the rustc guide? I know it's in other places, but I want to make it as visible as possible.

@nikomatsakis

nikomatsakis commented Feb 23, 2018•
edited
Loading

Copy link
Copy Markdown
Contributor

Oh, one other thing. I think there may be references to those deleted READMEs in doc-comments and things. Could you maybe redirect those to the appropriate URL in the rustc guide?

Examples:

rust/src/librustc/lib.rs

Line 14 in 063deba

//! has their own README with further details).

rust/src/librustc/lib.rs

Line 32 in 063deba

//! organized, see the README.md file in this directory.

rust/src/librustc/traits/mod.rs

Line 11 in 063deba

//! Trait Resolution. See README.md for an overview of how this works.

@nikomatsakis

nikomatsakis commented Feb 23, 2018

Copy link
Copy Markdown
Contributor

I found those by doing rg README.md | grep '.rs'

@mark-i-m

mark-i-m commented Feb 25, 2018

Copy link
Copy Markdown
ContributorAuthor

@nikomatsakis I think it should be fixed now... I also updated the list in rust-lang/rustc-dev-guide#2... I think a lot of those will be closed by your latest PR, but it can't hurt to list them...

@nikomatsakis

nikomatsakis commented Feb 27, 2018

Copy link
Copy Markdown
Contributor

@bors r+ rollup

@bors

bors commented Feb 27, 2018

Copy link
Copy Markdown
Collaborator

📌 Commit 7a82da1 has been approved by nikomatsakis

@borsbors 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 Feb 27, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Feb 28, 2018
@kennytm
Rollup merge ofrust-lang#48479- mark-i-m:rustc-guide, r=nikomatsakis
af55518
Start moving to the rustc guide!
r? @nikomatsakis
cc rust-lang#48478
@kennytmkennytm mentioned this pull request Feb 28, 2018
Merged
bors added a commit that referenced this pull request Feb 28, 2018
@bors
Auto merge of#48608- kennytm:rollup, r=kennytm
0ff9872
Rollup of 15 pull requests
- Successful merges: #48266, #48321, #48365, #48381, #48450, #48473, #48479, #48484, #48488, #48497, #48541, #48548, #48558, #48560, #48565
- Failed merges:
@bors
bors merged commit 7a82da1 into rust-lang:masterFeb 28, 2018
@teiestiteiesti mentioned this pull request Mar 1, 2018
Merged
Manishearth added a commit to Manishearth/rust that referenced this pull request Mar 1, 2018
@Manishearth
Rollup merge ofrust-lang#48626- teiesti:fix-readme, r=frewsxcv
a080d7b
Fix link to rustc guide in README.md
This is a follow-up to rust-lang#48479 and fixes a minor bug with the link to the rustc guide in the README.
r? @nikomatsakis
cc @mark-i-m
This was referenced Mar 13, 2018
Merged
Merged
@mark-i-m
mark-i-m deleted the rustc-guide branch November 14, 2018 16:40
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nikomatsakisnikomatsakisnikomatsakis requested changes

Assignees

@nikomatsakisnikomatsakis

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mark-i-m@nikomatsakis@bors@rust-highfive