Skip to content

/rust

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

Tracking issue for moving to rustc-guide #48478

Open
mark-i-m opened this Issue Feb 23, 2018 · 4 comments

Comments

Assignees
No one assigned
Labels
C-tracking-issue
Projects
None yet
Milestone
No milestone
3 participants
@mark-i-m @nikomatsakis @pietroalbini
@mark-i-m
Copy link
Contributor

mark-i-m commented Feb 23, 2018 •
edited

The rustc guide has made a lot of progress and has almost reached parity with the READMEs. Indeed, there is a lot of content that is only in the guide!

This is a tracking issue for completely getting rid of the READMEs, which are hard to find and often not coordinated with each other, and moving towards the guide.

  • Finish moving all READMEs to the guide. These are the ones that are left (I think):
  • Remove old READMEs that are not waiting for a system to be deleted:
  • In #57652 (comment), it was decided that these READMEs are still accurate and are waiting for their corresponding systems to be removed...
    • ./src/librustc_borrowck/borrowck/README.md
    • ./src/librustc/infer/region_constraints/README.md
    • ./src/librustc/infer/lexical_region_resolve/README.md
  • Decide where we want the rustc guide to live (in this repo or not?), then move it there.
    • It is a submodule to this repo, with the main rusct-guide repo living in rust-lang/rustc-guide

cc @nikomatsakis

@mark-i-m mark-i-m referenced this issue Feb 23, 2018

Merged

Start moving to the rustc guide! #48479

@nikomatsakis

This comment has been minimized.

Sign in to view
Copy link
Contributor

nikomatsakis commented Feb 23, 2018

Nice!

@pietroalbini pietroalbini added the C-tracking-issue label Feb 24, 2018

@mark-i-m

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

mark-i-m commented Feb 25, 2018

Found a few more READMEs to migrate...

kennytm added a commit to kennytm/rust that referenced this issue Feb 28, 2018

@kennytm
Rollup merge of rust-lang#48479 - mark-i-m:rustc-guide, r=nikomatsakis 
Start moving to the rustc guide!

r? @nikomatsakis

cc rust-lang#48478
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
af55518

This was referenced Mar 13, 2018

Merged
Merged

kennytm added a commit to kennytm/rust that referenced this issue Mar 14, 2018

@kennytm
Rollup merge of rust-lang#48971 - mark-i-m:fix_readmes, r=nikomatsakis 
Move librustc_typeck READMEs to rustc guide

cc rust-lang/rustc-guide#2 and rust-lang#48478

Don't merge this before rust-lang/rustc-guide#85

r? @nikomatsakis
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
597d112

kennytm added a commit to kennytm/rust that referenced this issue Mar 14, 2018

@kennytm
Rollup merge of rust-lang#48971 - mark-i-m:fix_readmes, r=nikomatsakis 
Move librustc_typeck READMEs to rustc guide

cc rust-lang/rustc-guide#2 and rust-lang#48478

Don't merge this before rust-lang/rustc-guide#85

r? @nikomatsakis
Verified
This commit was signed with a verified signature.
@kennytm kennytm
GPG key ID: FEF6C8051D0E013C Learn about signing commits
ff80cde

kennytm added a commit to kennytm/rust that referenced this issue Mar 15, 2018

@kennytm
Rollup merge of rust-lang#48972 - mark-i-m:rustdoc_readme, r=QuietMis… 
…dreavus

Move librustdoc readme to rustc guide

cc rust-lang/rustc-guide#2 and rust-lang#48478

Don't merge this before rust-lang/rustc-guide#86
Verified
This commit was signed with a verified signature.
@kennytm kennytm
GPG key ID: FEF6C8051D0E013C Learn about signing commits
db2f0ae
@mark-i-m

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

mark-i-m commented Mar 16, 2018

Updated with next steps...

@mark-i-m mark-i-m referenced this issue Mar 16, 2018

Merged

Replace many of the last references to readmes #49092

kennytm added a commit to kennytm/rust that referenced this issue Mar 19, 2018

@kennytm
Rollup merge of rust-lang#49092 - mark-i-m:deptrack_readme, r=nikomat… 
…sakis

Replace many of the last references to readmes

In particular, this removes the dep track readme, so it should not be merged before rust-lang/rustc-guide#92

Fix rust-lang#47935

cc rust-lang#48478

r? @nikomatsakis
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
7bc9fe3

@mark-i-m mark-i-m referenced this issue Apr 6, 2018

Merged

Add "the Rustc book" #49707

@mark-i-m mark-i-m referenced this issue Jan 16, 2019

Merged

Update/remove some old readmes #57652

@mark-i-m

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

mark-i-m commented Jan 18, 2019

Updated after #57652

Centril added a commit to Centril/rust that referenced this issue Jan 25, 2019

@Centril
Rollup merge of rust-lang#57652 - mark-i-m:remove-old, r=nikomatsakis 
Update/remove some old readmes

r? @nikomatsakis

cc rust-lang#48478

There are a bunch of READMEs with content that I would like to see a final decision made on:
- https://github.com/rust-lang/rust/tree/master/src/librustc/ty/query
- https://github.com/rust-lang/rust/tree/master/src/librustc/dep_graph
- https://github.com/rust-lang/rust/blob/master/src/librustc/infer/region_constraints
- https://github.com/rust-lang/rust/tree/master/src/librustc/infer/higher_ranked
- https://github.com/rust-lang/rust/tree/master/src/librustc/infer/lexical_region_resolve
- https://github.com/rust-lang/rust/blob/master/src/librustc_borrowck/borrowck

It's not clear how useful or obsolete any of these are. I would really appreciate if the appropriate domain experts for each of these could respond with one of (a) delete it, (b) wait for system to be remove, or (c) move it to rustc-guide. @nikomatsakis do you know who to ping for any of these (sorry, I suspect many of them are you)?
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
2876801

@mark-i-m mark-i-m changed the title Tracking issue for the rustc-guide Tracking issue for moving to rustc-guide Apr 3, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.