diff --git a/content/_index.md b/content/_index.md index 61c3ae49..7dc159b7 100644 --- a/content/_index.md +++ b/content/_index.md @@ -7,16 +7,16 @@ type: docs A home for compiler team planning documents, meeting minutes, and other such things. If you're interested in learning about how **rustc** works -- as well as advice on building the compiler, preparing a PR, -and other similar topics -- check out the [rustc-guide]. +and other similar topics -- check out the [rustc-dev-guide]. -[rustc-guide]: https://rust-lang.github.io/rustc-guide/ +[rustc-dev-guide]: https://rust-lang.github.io/rustc-dev-guide/ ## Quick facts - **Where to find us:** We are primarily present on [Zulip](about/chat-platform), though some of us also monitor Discord. - **Want to attend a meeting or follow along?** See the "meeting calendar" section below. - **Looking for technical information about how the compiler works?** - Check out the [rustc-guide](https://rust-lang-nursery.github.io/rustc-guide/). + Check out the [rustc-dev-guide](https://rust-lang-nursery.github.io/rustc-dev-guide/). ## Meeting Calendar @@ -73,7 +73,7 @@ Name | Status | Short [MIR Optimizations](working-groups/mir-opt/) | Active | Write MIR optimizations and refactor the MIR to be more optimizable. | [#t-compiler/wg-mir-opt][mir-opt-stream] [Rustc pipelining](working-groups/pipelining/) | Active | Enable Cargo to invoke rustc in a pipelined fashion, speeding up crate graph compiles. | [#t-compiler/wg-pipelining][pipelining-stream] [Polonius](working-groups/polonius/) | Active | Exploring the integration of the "NLL 2.0"-like ["Polonius analysis"][Polonius] into rustc | [#t-compiler/wg-polonius][polonius_stream] -[Learning](working-groups/learning/) | Active | Make the compiler easier to learn by ensuring that rustc-guide and api docs are "complete" | [#t-compiler/wg-learning][learning_stream] +[Learning](working-groups/learning/) | Active | Make the compiler easier to learn by ensuring that rustc-dev-guide and api docs are "complete" | [#t-compiler/wg-learning][learning_stream] [Diagnostics](working-groups/diagnostics/) | Active | Use crates.io crates for diagnostics rendering and make emitting diagnostics nicer. | [#t-compiler/wg-diagnostics][diagnostics_stream] [Polymorphization](working-groups/polymorphization/) | Active | Implement an analysis to detect when functions can remain polymorphic during code generation. | [#t-compiler/wg-polymorphization][polymorphization_stream] [Profile-Guided Optimization](working-groups/pgo/) | Retired | Implementing profile-guided optimization for rustc | [#t-compiler/wg-profile-guided-optimization][pgo_stream] diff --git a/content/minutes/design-meeting/2019-07-08-triage-wg.md b/content/minutes/design-meeting/2019-07-08-triage-wg.md index b3d4bce2..c3061d46 100644 --- a/content/minutes/design-meeting/2019-07-08-triage-wg.md +++ b/content/minutes/design-meeting/2019-07-08-triage-wg.md @@ -106,7 +106,7 @@ assigned to do a preliminary review or fix. We need to improve the "expert map" to be more complex and also to include "levels of knowledge". Perhaps rename it to "knowledge map" or something like that. Also, this can be a great way to figure out things that need to -be added to the rustc-guide. +be added to the rustc-dev-guide. [expert map]: https://github.com/rust-lang/compiler-team/blob/master/experts/MAP.md diff --git a/content/minutes/design-meeting/2019-10-11-DepGraph-persistence-PR62038.md b/content/minutes/design-meeting/2019-10-11-DepGraph-persistence-PR62038.md index abd1a0ce..bf5f803e 100644 --- a/content/minutes/design-meeting/2019-10-11-DepGraph-persistence-PR62038.md +++ b/content/minutes/design-meeting/2019-10-11-DepGraph-persistence-PR62038.md @@ -13,7 +13,7 @@ Dear @*T-compiler/meeting*, Today we will be having a **design meeting**. The topic was originally sketched as "some Zoxc PR". We've since narrowed that down to discuss #62038, which is a refactoring to how dep-graph loading occurs. @**Zoxc** [wrote up a comment](https://github.com/rust-lang/rust/pull/62038#issuecomment-540508308) giving a summary of the ideas. Note that this PR itself is an incremental step towards #60035, which aims to make dep-graph loading/saving more continuous. -I'd also like to discuss briefly how we should document these changes. We currently have some rustc-chapters on incremental compilation (e.g., [this chapter goes into detail](https://rust-lang.github.io/rustc-guide/queries/incremental-compilation-in-detail.html)). I would like to move us to a world where major refactorings like #60035 (but not limited to this one -- I think e.g. [my recent PR](https://github.com/rust-lang/rust/pull/65232) and work on lazy norm fits the bill) come along with a rustc-guide chapter that documents the new state of the world. Maybe we discuss some how that might work and -- in the case of THIS PR -- who might do that documentation work (I don't necessarily think it has to be @**Zoxc**, though they're also an obvious candidate). (In my ideal world, drafts of that chapter would be available *before* the PR, but at minimum I think such a chapter should be in place to help with reviewing.) +I'd also like to discuss briefly how we should document these changes. We currently have some rustc-chapters on incremental compilation (e.g., [this chapter goes into detail](https://rust-lang.github.io/rustc-dev-guide/queries/incremental-compilation-in-detail.html)). I would like to move us to a world where major refactorings like #60035 (but not limited to this one -- I think e.g. [my recent PR](https://github.com/rust-lang/rust/pull/65232) and work on lazy norm fits the bill) come along with a rustc-dev-guide chapter that documents the new state of the world. Maybe we discuss some how that might work and -- in the case of THIS PR -- who might do that documentation work (I don't necessarily think it has to be @**Zoxc**, though they're also an obvious candidate). (In my ideal world, drafts of that chapter would be available *before* the PR, but at minimum I think such a chapter should be in place to help with reviewing.) ## Questions for discussion @@ -54,5 +54,5 @@ I'd also like to discuss briefly how we should document these changes. We curren * Conclusion: * Follow-up meeting to dig into design of #60035 and maybe discuss alternatives * In parallel, Niko will review #62038 now that he understands roughly what it is trying to do - * We would also want to write docs for rustc-guide + * We would also want to write docs for rustc-dev-guide * We can figure out how that happens in parallel diff --git a/content/minutes/design-meeting/2019-12-20-major-change-process.md b/content/minutes/design-meeting/2019-12-20-major-change-process.md index df1d492c..3dd0a849 100644 --- a/content/minutes/design-meeting/2019-12-20-major-change-process.md +++ b/content/minutes/design-meeting/2019-12-20-major-change-process.md @@ -120,8 +120,8 @@ We would know the system is working if: * the only "hard block" would be if you don't have a "partner" or "sponsor" from compiler team * somewhat analogous to the project group lang team concepts * reviewer not expected to be a pair programmer -* one possible definition for "what is a major change" might be "what would modify the rustc-guide" - * or, since rustc-guide is always a WIP, "welp this *should've* in the guide and if it were, it *would've* required a modification" +* one possible definition for "what is a major change" might be "what would modify the rustc-dev-guide" + * or, since rustc-dev-guide is always a WIP, "welp this *should've* in the guide and if it were, it *would've* required a modification" * what to do with new PRs that don't follow the process? * should we close them? * maybe have a canned comment and give them some amount of time @@ -143,8 +143,8 @@ We would know the system is working if: * would like to review performance results * we need a `-Z` flag * we need docs :) -* final discussion point was about exactly how to handle requests for rustc-guide edits - * since a major change is part of a rustc-guide change, it makes sense that it should come accompanied with a rustc-guide write-up +* final discussion point was about exactly how to handle requests for rustc-dev-guide edits + * since a major change is part of a rustc-dev-guide change, it makes sense that it should come accompanied with a rustc-dev-guide write-up * ideally this would come along with the compiler-team issue * but maybe it would be more something we wait for until issue is *approved* or, in extreme cases, co-develop with author * if we want to see more docs, we are going to have to start holding the line *somewhere* @@ -152,7 +152,7 @@ We would know the system is working if: * details may change through review process * person may not know enough context to write the docs, need help with that * but the bar should be that the issue can **explain the change** in sufficient detail for it to be understood - * the *actual* rustc-guide changes themselves can come later + * the *actual* rustc-dev-guide changes themselves can come later * it may be that the role of the learning wg can be to help with some of that ## Final proposed process @@ -162,8 +162,8 @@ We would know the system is working if: * Identify mentors or reviewers, if you are working with one * There will be some "prototype" to guide people in this * What is a "major change"? - * something where it would make sense to update rustc-guide - * if rustc-guide doesn't cover this code yet, then you may have to use your imagination about what *ought* to be documented :) + * something where it would make sense to update rustc-dev-guide + * if rustc-dev-guide doesn't cover this code yet, then you may have to use your imagination about what *ought* to be documented :) * These issues will be reviewed by compiler team members * Compiler team members and contributors can leave concerns and approvals asynchronously (see below) * maybe we can make a dedicated Zulip stream where new things get diff --git a/content/minutes/steering-meeting/2018-10-26.md b/content/minutes/steering-meeting/2018-10-26.md index 1de168f4..c91f2716 100644 --- a/content/minutes/steering-meeting/2018-10-26.md +++ b/content/minutes/steering-meeting/2018-10-26.md @@ -31,4 +31,4 @@ We pointed out that when we do our planning at [the next Rust All Hands](https:/ We discussed some how the [diagnostics efforts could be increased](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-10-26/near/136551512). -We discussed [the rustc-guide](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-10-26/near/136552030) as well as the [NLL contributor YouTube videos](https://www.youtube.com/playlist?list=PLCQVvhKUrTN9VfaQx2AyOSAstwENaGkYA) and ways to improve them. One solid thought was that we might want to create a rustc-guide WG ([which has its own zulip topic here](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rustc-guide-wg)). We talked in particular about how both [experienced folks and newcomers can contribute there](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-10-26/near/136552969). \ No newline at end of file +We discussed [the rustc-dev-guide](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-10-26/near/136552030) as well as the [NLL contributor YouTube videos](https://www.youtube.com/playlist?list=PLCQVvhKUrTN9VfaQx2AyOSAstwENaGkYA) and ways to improve them. One solid thought was that we might want to create a rustc-dev-guide WG ([which has its own zulip topic here](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rustc-guide-wg)). We talked in particular about how both [experienced folks and newcomers can contribute there](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-10-26/near/136552969). \ No newline at end of file diff --git a/content/minutes/steering-meeting/2018-12-14.md b/content/minutes/steering-meeting/2018-12-14.md index 6d30c6c0..3796e456 100644 --- a/content/minutes/steering-meeting/2018-12-14.md +++ b/content/minutes/steering-meeting/2018-12-14.md @@ -35,7 +35,7 @@ experienced](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/su - writing tests can be driven via [code coverage measurements](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151782245) - writing docs can be driven via [`deny(missing_docs)`](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151781803) - as well as [push to complete the missing rustc-guide + as well as [push to complete the missing rustc-dev-guide sections](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151781969) - one problem with writing documentation is that [there always seems to be something that is higher @@ -55,11 +55,11 @@ is documented. - [before landing a massive refactoring or new architecture](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784501): - ideally, [talk out the design on an internals thread to achieve some light consensus](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784204) - - expect documentation [in the form of rustc-guide chapters](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151783865) + - expect documentation [in the form of rustc-dev-guide chapters](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151783865) - some examples where we should do this: - [end-to-end queries](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151783972) - [parallel query execution](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784316) -- in terms of the rustc-guide: +- in terms of the rustc-dev-guide: - it'd be [great to improve mdbook to permit for graphs](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151783887) - maybe we can [add graphviz support into mdbook](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784431) - we should [not neglect doc comments](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784445) diff --git a/content/minutes/steering-meeting/2019-01-04.md b/content/minutes/steering-meeting/2019-01-04.md index 3329455d..98475b4d 100644 --- a/content/minutes/steering-meeting/2019-01-04.md +++ b/content/minutes/steering-meeting/2019-01-04.md @@ -37,7 +37,7 @@ e.g., rustdoc or RLS. We discussed some possibler areas for discussion: -- [the rustc-guide](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415509) +- [the rustc-dev-guide](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415509) - [related work, like RLS, rustdoc,](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415505) or [cranelift](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415743) - [mentoring?](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415632) diff --git a/content/minutes/steering-meeting/2019-03-01.md b/content/minutes/steering-meeting/2019-03-01.md index 65b3fad9..7f0166b4 100644 --- a/content/minutes/steering-meeting/2019-03-01.md +++ b/content/minutes/steering-meeting/2019-03-01.md @@ -92,10 +92,10 @@ responsible for any repository we create in the rust-lang organization. valuable and should point to the responsible working group. Changing gears, [@mw][mw] asked if there were any example workflows for handling changes in external -crates to which [@nikomatsakis][nikomatsakis] suggested that a rustc-guide chapter on that and +crates to which [@nikomatsakis][nikomatsakis] suggested that a rustc-dev-guide chapter on that and how to make local copies for debugging would be necessary. [@davidtwco][davidtwco] asked what information should be kept in the policy document and what information should be kept in the -rustc-guide. There was some consensus that setting up a new out-of-tree crate is policy and working +rustc-dev-guide. There was some consensus that setting up a new out-of-tree crate is policy and working with one is for the guide. [@mw][mw] then raised the question of where consent of compiler team members should be gathered diff --git a/content/minutes/steering-meeting/2019-04-12.md b/content/minutes/steering-meeting/2019-04-12.md index ce9cbffe..bc80ef83 100644 --- a/content/minutes/steering-meeting/2019-04-12.md +++ b/content/minutes/steering-meeting/2019-04-12.md @@ -99,7 +99,7 @@ wind up detailed enough that [frequent contributors can pick them up and implement them](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019.2E04.2E12.20.2358850/near/163195172), even if the people *making* the design are busy with other things. -Similarly, [design documents can become the basis for rustc-guide +Similarly, [design documents can become the basis for rustc-dev-guide chapters](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019.2E04.2E12.20.2358850/near/163195352). [We plan to flesh out some more details and put this idea into action diff --git a/content/minutes/triage-meeting/2019-08-15.md b/content/minutes/triage-meeting/2019-08-15.md index 234f7208..6687f0c0 100644 --- a/content/minutes/triage-meeting/2019-08-15.md +++ b/content/minutes/triage-meeting/2019-08-15.md @@ -18,12 +18,12 @@ type: docs ### [wg-learning](https://rust-lang.github.io/compiler-team/working-groups/learning/) -wg-learning's objective is to make the compiler easier to learn by ensuring that rustc-guide and api docs are "complete". +wg-learning's objective is to make the compiler easier to learn by ensuring that rustc-dev-guide and api docs are "complete". Currently they're working on: 1. Getting [video lectures](https://www.youtube.com/watch?v=mAUGvNgZYtw) about parts of the compiler from people who know them -2. Turning existing video lectures into content for the [rustc-guide](https://github.com/rust-lang/rustc-guide) +2. Turning existing video lectures into content for the [rustc-dev-guide](https://github.com/rust-lang/rustc-dev-guide) 3. Triaging and working on issues and pull requests for learning content Help is always wanted! diff --git a/content/minutes/triage-meeting/2019-10-10.md b/content/minutes/triage-meeting/2019-10-10.md index 7831dbf6..dcf1c37c 100644 --- a/content/minutes/triage-meeting/2019-10-10.md +++ b/content/minutes/triage-meeting/2019-10-10.md @@ -39,7 +39,7 @@ type: docs ### [wg-learning](https://rust-lang.github.io/compiler-team/working-groups/learning/) -- `wg-learning` has been working on transcribing videos from the [compiler lecture series](https://www.youtube.com/watch?v=elBxMRSNYr4&list=PL85XCvVPmGQhOL-J2Ng7qlPvDVOwYpGTN) into [rustc-guide](https://rust-lang.github.io/rustc-guide/) chapters. +- `wg-learning` has been working on transcribing videos from the [compiler lecture series](https://www.youtube.com/watch?v=elBxMRSNYr4&list=PL85XCvVPmGQhOL-J2Ng7qlPvDVOwYpGTN) into [rustc-dev-guide](https://rust-lang.github.io/rustc-dev-guide/) chapters. - Originally, individuals were assigned one or lectures to complete but that hasn't worked very well. diff --git a/content/minutes/triage-meeting/2019-10-17.md b/content/minutes/triage-meeting/2019-10-17.md index f84c1a1a..39bdd172 100644 --- a/content/minutes/triage-meeting/2019-10-17.md +++ b/content/minutes/triage-meeting/2019-10-17.md @@ -52,9 +52,9 @@ type: docs - The [Inside Rust](https://blog.rust-lang.org/inside-rust/index.html) blog has launched. -- The [ICE-Breaker group](https://rust-lang.github.io/rustc-guide/ice-breaker/about.html) has been formed! +- The [ICE-Breaker group](https://rust-lang.github.io/rustc-dev-guide/ice-breaker/about.html) has been formed! -- The [LLVM ICE-Breaker group](https://rust-lang.github.io/rustc-guide/ice-breaker/llvm.html) is also being formed. +- The [LLVM ICE-Breaker group](https://rust-lang.github.io/rustc-dev-guide/ice-breaker/llvm.html) is also being formed. [Link to full conversation](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/weekly.20meeting.202019-10-17.20.2354818/near/178389266) diff --git a/content/minutes/triage-meeting/2019-10-31.md b/content/minutes/triage-meeting/2019-10-31.md index 2b6c78b4..fc11a0f2 100644 --- a/content/minutes/triage-meeting/2019-10-31.md +++ b/content/minutes/triage-meeting/2019-10-31.md @@ -21,7 +21,7 @@ Rust 1.39 ships on Thursday! ### [wg-pgo](https://rust-lang.github.io/compiler-team/working-groups/pgo/) -- PGO is available in the stable compiler. Docs are in the rustc-guide and the rustc-book +- PGO is available in the stable compiler. Docs are in the rustc-dev-guide and the rustc-book - Unfortunately we don't observe significant performance gains from applying it (except for tiny synthetic test cases). diff --git a/content/minutes/triage-meeting/2019-12-05.md b/content/minutes/triage-meeting/2019-12-05.md index 8c677c2c..c300ee93 100644 --- a/content/minutes/triage-meeting/2019-12-05.md +++ b/content/minutes/triage-meeting/2019-12-05.md @@ -32,7 +32,7 @@ Accomplished: - We have a [PR for the ty chapter][ty_chapter], it summarizes [this lecture][lecture_2]. -- We had a [planning meeting][meeting], where we come up with a [document with ideas and next steps][doc] for the rustc-guide. We've basically defined kind of a roadmap and a way to work towards those goals. +- We had a [planning meeting][meeting], where we come up with a [document with ideas and next steps][doc] for the rustc-dev-guide. We've basically defined kind of a roadmap and a way to work towards those goals. Next-steps: @@ -56,6 +56,6 @@ Next-steps: [lecture_1]: https://www.youtube.com/watch?v=_muY4HjSqVw [lecture_2]: https://www.youtube.com/watch?v=c01TsOsr3-c [meeting]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning/topic/planning.20meeting -[salsa_chapter]: https://github.com/rust-lang/rustc-guide/pull/529 -[ty_chapter]: https://github.com/rust-lang/rustc-guide/pull/530 +[salsa_chapter]: https://github.com/rust-lang/rustc-dev-guide/pull/529 +[ty_chapter]: https://github.com/rust-lang/rustc-dev-guide/pull/530 [wg-learning]: https://rust-lang.github.io/compiler-team/working-groups/learning diff --git a/content/procedures/crates.md b/content/procedures/crates.md index cbe92c8f..b612d01e 100644 --- a/content/procedures/crates.md +++ b/content/procedures/crates.md @@ -95,8 +95,8 @@ Linkifiers for auto-linking to issues and PRs on the primary Rust Zulip server c request. ### Are there any recommendations for working with out-of-tree crates? -Recommendations for working with out-of-tree crates will be documented in the rustc-guide (see -[rust-lang/rustc-guide#285][guide_issue] for progress). +Recommendations for working with out-of-tree crates will be documented in the rustc-dev-guide (see +[rust-lang/rustc-dev-guide#285][guide_issue] for progress). ### How should stabilization/semantic changes be handled in out-of-tree crates? It is important to involve the language team in any changes in out-of-tree crates that would result @@ -106,7 +106,7 @@ were implemented in `rust-lang/rust` directly, include a description of the chan obvious to those unfamiliar with the compiler or the out-of-tree crate. [licenses]: https://github.com/rust-lang/rust/blob/master/src/tools/tidy/src/deps.rs#L10-L19 -[guide_issue]: https://github.com/rust-lang/rustc-guide/issues/285 +[guide_issue]: https://github.com/rust-lang/rustc-dev-guide/issues/285 --- diff --git a/content/working-groups/learning/_index.md b/content/working-groups/learning/_index.md index ac9dc65e..6e852b9c 100644 --- a/content/working-groups/learning/_index.md +++ b/content/working-groups/learning/_index.md @@ -5,7 +5,7 @@ type: docs # Learning Working Group ![working group status: active][status] -This working group aims to make the compiler easier to learn by ensuring that rustc-guide and api docs are "complete". +This working group aims to make the compiler easier to learn by ensuring that rustc-dev-guide and api docs are "complete". - **Leads:** [@spastorino][spastorino] and [@mark-i-m][markim] - **Meeting Notes:** @@ -29,7 +29,7 @@ This working group aims to make the compiler easier to learn by ensuring that ru ## What is the goal of this working group? This working group aims to accomplish the following: -- Ensure that major components of rustc are covered in rustc-guide +- Ensure that major components of rustc are covered in rustc-dev-guide - Ensure that API doc coverage is at least 90% # How can I get involved? @@ -39,12 +39,12 @@ pinged when there are available tasks. ## Process We are trying to follow a "sprint-like" structure where on each "sprint" cycle we start with a planning and then -work towards the goals defined on that plan. Our current plan is to work for 2 months on a couple of goals, with a few meetings to sync up during that period. We are working towards filling out missing parts of the rustc-guide and building some chapters that help gain an overall understanding of what the compiler does to code to produce its output. +work towards the goals defined on that plan. Our current plan is to work for 2 months on a couple of goals, with a few meetings to sync up during that period. We are working towards filling out missing parts of the rustc-dev-guide and building some chapters that help gain an overall understanding of what the compiler does to code to produce its output. - **Desired experience level:** Any -- **Relevant repositories:** [`rust-lang/rust`][rust-repo] and [`rust-lang/rustc-guide`][rustc-guide-repo] +- **Relevant repositories:** [`rust-lang/rust`][rust-repo] and [`rust-lang/rustc-dev-guide`][rustc-dev-guide-repo] - **Zulip stream:** [`#t-compiler/wg-learning`][zulip] on Zulip [rust-repo]: https://github.com/rust-lang/rust -[rustc-guide-repo]: https://github.com/rust-lang/rustc-guide +[rustc-dev-guide-repo]: https://github.com/rust-lang/rustc-dev-guide [zulip]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning diff --git a/content/working-groups/learning/minutes/2019.05.14-meeting.md b/content/working-groups/learning/minutes/2019.05.14-meeting.md index 93eb8fea..097374c0 100644 --- a/content/working-groups/learning/minutes/2019.05.14-meeting.md +++ b/content/working-groups/learning/minutes/2019.05.14-meeting.md @@ -7,7 +7,7 @@ type: docs ## Topics discussed: - Define what’s the walkthrough section we want to add -- Triage missing rustc-guide chapters +- Triage missing rustc-dev-guide chapters - How do we want to keep track of who is doing what? Does github Projects works nice for this? @@ -21,7 +21,7 @@ type: docs Status: - lokalmatador is giving this a try & will open a PR at some point -## rustc-guide missing chapters +## rustc-dev-guide missing chapters Topics that need to be added @@ -55,7 +55,7 @@ Status: - planning to use github issues. - Two issues were created to track existing work: - - https://github.com/rust-lang/rustc-guide/issues/319 - - https://github.com/rust-lang/rustc-guide/issues/320 + - https://github.com/rust-lang/rustc-dev-guide/issues/319 + - https://github.com/rust-lang/rustc-dev-guide/issues/320 - discussed possible use of GH projects - for now we will move TODO list to GH issues from dropbox \ No newline at end of file diff --git a/content/working-groups/learning/minutes/2019.05.28-meeting.md b/content/working-groups/learning/minutes/2019.05.28-meeting.md index 84913a03..b0a612d1 100644 --- a/content/working-groups/learning/minutes/2019.05.28-meeting.md +++ b/content/working-groups/learning/minutes/2019.05.28-meeting.md @@ -4,9 +4,9 @@ type: docs --- # Learning WG 2019-05-28 sync meeting -## Triaging rustc-guide repo +## Triaging rustc-dev-guide repo -- Some discussion about how to assign issues on the rust-lang/rustc-guide repo +- Some discussion about how to assign issues on the rust-lang/rustc-dev-guide repo - Problem: can't assign issues to non-members - Possible solutions: - Add WG-learning members to repo so they can be assigned @@ -14,7 +14,7 @@ type: docs ## Forge -- Discussed purpose of the forge and how it differs from rustc-guide +- Discussed purpose of the forge and how it differs from rustc-dev-guide - Niko feels that most of the content in the forge doesn't obviously belong in the guide and that the stuff currently in the guide feels like it belongs in the guide - Forge is for team procedures, infra stuff - would also be good to add craterbot and rustc-timer links to forge (probably link to READMEs of their repos) diff --git a/content/working-groups/learning/minutes/2019.06.11-meeting.md b/content/working-groups/learning/minutes/2019.06.11-meeting.md index 0a2e1e1e..1a898f7d 100644 --- a/content/working-groups/learning/minutes/2019.06.11-meeting.md +++ b/content/working-groups/learning/minutes/2019.06.11-meeting.md @@ -26,13 +26,13 @@ type: docs - libssl dependency is annoying (need to investigate) - Closure desugaring work (mark-i-m) - - https://github.com/blitzerr/rustc-guide/pull/1 + - https://github.com/blitzerr/rustc-dev-guide/pull/1 - waiting on author who seems busy... will probably just merge and iterate later - Organizing MIR and HAIR talks (spastorino) - oli-obk is going to do something this month, needs time -## Triaging rustc-guide +## Triaging rustc-dev-guide - spastorino will ask @Pietro Albini about progress on triagebot. - If triagebot will be ready soon, wait. @@ -43,6 +43,6 @@ type: docs - There is a planned contributing page: https://github.com/rust-lang/www.rust-lang.org/issues/440 - If someone has time we (WG-learning) should try to push that forward, otherwise, waiting for this to be done... -## adding people rustc-guide toolstate +## adding people rustc-dev-guide toolstate - spastorino volunteers to be added \ No newline at end of file diff --git a/content/working-groups/learning/minutes/2019.06.25-meeting.md b/content/working-groups/learning/minutes/2019.06.25-meeting.md index 50bdf4bc..14aa9cc7 100644 --- a/content/working-groups/learning/minutes/2019.06.25-meeting.md +++ b/content/working-groups/learning/minutes/2019.06.25-meeting.md @@ -26,7 +26,7 @@ type: docs - Doesn't look like any of the papers are particular to any part of compiler, but they are interesting/useful -- mark-i-m will add as an appendix to rustc-guide +- mark-i-m will add as an appendix to rustc-dev-guide - related discussion: - lokalmatador will link to lecture videos from their walkthrough chapter diff --git a/content/working-groups/learning/minutes/2019.07.23-meeting.md b/content/working-groups/learning/minutes/2019.07.23-meeting.md index e25454db..0dfea76b 100644 --- a/content/working-groups/learning/minutes/2019.07.23-meeting.md +++ b/content/working-groups/learning/minutes/2019.07.23-meeting.md @@ -4,7 +4,7 @@ type: docs --- # Learning WG 2019-07-23 sync meeting -## Rustc-guide strike force +## rustc-dev-guide strike force - Need to go through older issues on repo and see what is actionable for each one - Easier issues need to just get done diff --git a/content/working-groups/learning/minutes/2019.08.06-meeting.md b/content/working-groups/learning/minutes/2019.08.06-meeting.md index 0367c748..a15eeb07 100644 --- a/content/working-groups/learning/minutes/2019.08.06-meeting.md +++ b/content/working-groups/learning/minutes/2019.08.06-meeting.md @@ -10,7 +10,7 @@ type: docs - The linkchecker in the rust CI is run from https://github.com/rust-lang/rust/tree/master/src/tools/rustbook. - It just runs `mdbook_linkcheck` as a library. - That is called by only one linux builder from the script in `src/ci/docker/`. - - The hack on the `rustc-guide` CI checks the output of `mdbook_linkcheck` from `stdout/stderr` and looks for timeout errors. + - The hack on the `rustc-dev-guide` CI checks the output of `mdbook_linkcheck` from `stdout/stderr` and looks for timeout errors. - If timeout errors are equal to the number of errors `mdbook_linkcheck` reported, then build is passed. - @Santiago Pastorino mentions two major tasks for the WG (in an explanation): diff --git a/content/working-groups/learning/minutes/2019.09.17-meeting.md b/content/working-groups/learning/minutes/2019.09.17-meeting.md index d2472862..c6af3706 100644 --- a/content/working-groups/learning/minutes/2019.09.17-meeting.md +++ b/content/working-groups/learning/minutes/2019.09.17-meeting.md @@ -5,12 +5,12 @@ type: docs # Learning WG 2019-09-17 sync meeting - Team discussed that we all are going to watch same video - - This lecture https://github.com/rust-lang/rustc-guide/issues/375 + - This lecture https://github.com/rust-lang/rustc-dev-guide/issues/375 - Notes and questions to be discussed in a separate meeting on Tue, 24 September, 15:30 - @mark-i-m reported - We are now using mdbook-linkcheck 0.4, which has caching - - Opening PR https://github.com/rust-lang/rustc-guide/pull/446 to add instructions about fixing toolslate + - Opening PR https://github.com/rust-lang/rustc-dev-guide/pull/446 to add instructions about fixing toolslate - @Iñaki Garay reported that the effort to summarize the videos was underestimated. - @Amanjeev Sethi agreed diff --git a/content/working-groups/learning/minutes/2019.10.01-meeting.md b/content/working-groups/learning/minutes/2019.10.01-meeting.md index 668da4dd..805500d0 100644 --- a/content/working-groups/learning/minutes/2019.10.01-meeting.md +++ b/content/working-groups/learning/minutes/2019.10.01-meeting.md @@ -6,13 +6,13 @@ type: docs - Team discussed that watching same video by all members, one video at a time, works well for everyone so far - Everyone is [taking notes in this paper doc](https://paper.dropbox.com/doc/Ty-lecture-summary--AlwygwSe9rh1NVn2BB6CaBB9Ag-4jFj9bVOLlW7uhIOWHITX). - - Discussion was about this lecture https://github.com/rust-lang/rustc-guide/issues/375 + - Discussion was about this lecture https://github.com/rust-lang/rustc-dev-guide/issues/375 -- @Santiago Pastorino reported that [How to build and run guide page needs help](https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html) +- @Santiago Pastorino reported that [How to build and run guide page needs help](https://rust-lang.github.io/rustc-dev-guide/how-to-build-and-run.html) - Team might create a new doc for this page to collect ideas. - @mark-i-m reported that - - 1) It seems our CI is broken, as this should not be passing: https://travis-ci.com/rust-lang/rustc-guide/builds/129892160 + - 1) It seems our CI is broken, as this should not be passing: https://travis-ci.com/rust-lang/rustc-dev-guide/builds/129892160 - @Amanjeev Sethi chose to take up on this task. - 2) There are a bunch of broken links in the Chalk chapter - @Tshepang Lekhonkhobe chose to take up on this task. diff --git a/content/working-groups/learning/minutes/2019.11.26-meeting.md b/content/working-groups/learning/minutes/2019.11.26-meeting.md index 5f53d60e..30dc29c0 100644 --- a/content/working-groups/learning/minutes/2019.11.26-meeting.md +++ b/content/working-groups/learning/minutes/2019.11.26-meeting.md @@ -27,5 +27,5 @@ type: docs [master doc]: https://hackmd.io/iamkyR_QTdSIdGjYQX_XjQ -[PR for Ty lecture]: https://github.com/rust-lang/rustc-guide/pull/530 +[PR for Ty lecture]: https://github.com/rust-lang/rustc-dev-guide/pull/530 [doc for Overview chapter]: https://hackmd.io/j8EsXGI1RiOnjZSiSRf3ng diff --git a/content/working-groups/llvm/_index.md b/content/working-groups/llvm/_index.md index 1e0c0a46..ca874bf4 100644 --- a/content/working-groups/llvm/_index.md +++ b/content/working-groups/llvm/_index.md @@ -66,5 +66,5 @@ something to do with how LLVM works. For the time being this is the best place t [Code Reviews with Phabricator]: https://llvm.org/docs/Phabricator.html [Getting Started with the LLVM System]: https://www.llvm.org/docs/GettingStarted.html [Intro to LLVM]: http://www.aosabook.org/en/llvm.html -[codegen section]: https://rust-lang.github.io/rustc-guide/codegen.html -[rustc guide]: https://rust-lang.github.io/rustc-guide/ \ No newline at end of file +[codegen section]: https://rust-lang.github.io/rustc-dev-guide/codegen.html +[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/ \ No newline at end of file diff --git a/content/working-groups/meta/_index.md b/content/working-groups/meta/_index.md index be08154f..1d7ff4ec 100644 --- a/content/working-groups/meta/_index.md +++ b/content/working-groups/meta/_index.md @@ -23,7 +23,7 @@ This working group aims to discuss and answer the following unresolved questions - How to organize compiler team calendar? - One calendar for everything or one per working group? - How to organize videos so people can find them? - - e.g. playlists on YouTube, rustc-guide chapter + - e.g. playlists on YouTube, rustc-dev-guide chapter - How do we make it easy to add them? - Some are specific to a working group or limited subset of contributors? - How to run open-ended tasks? @@ -68,7 +68,7 @@ This working group aims to discuss and answer the following unresolved questions - How can we encourage up-front design and documentation? - How much is too much? - e.g. pipelined compilation, parallel rustc - - How does this interact with the rustc-guide? + - How does this interact with the rustc-dev-guide? - API documentation - Should there be a working group focusing on this? - Async vs sync communication diff --git a/content/working-groups/meta/rfc-drafts/compiler-team-contributors.md b/content/working-groups/meta/rfc-drafts/compiler-team-contributors.md index ed9a58cf..0fa89c38 100644 --- a/content/working-groups/meta/rfc-drafts/compiler-team-contributors.md +++ b/content/working-groups/meta/rfc-drafts/compiler-team-contributors.md @@ -223,7 +223,7 @@ variety of tasks that need to be done to support the compiler and which should make one eligible for membership. Such tasks would include organizing meetings, participating in meetings, bisecting and triaging issues, writing documentation, working on the -rustc-guide. The most important criteria for elevation to contributor, +rustc-dev-guide. The most important criteria for elevation to contributor, in particular, is **regular and consistent** participation. The most important criteria for elevation to member is **actively shaping the direction of the team or compiler**. diff --git a/content/working-groups/mir-opt/_index.md b/content/working-groups/mir-opt/_index.md index d56f87d8..cd76cb0c 100644 --- a/content/working-groups/mir-opt/_index.md +++ b/content/working-groups/mir-opt/_index.md @@ -43,7 +43,7 @@ and context: - MIR is an intermediate representation used within the compiler. We are looking to transform instances of MIR into "better" instances. You can read about the MIR in - the [relevant rustc-guide chapter](https://rust-lang.github.io/rustc-guide/mir/index.html). + the [relevant rustc-dev-guide chapter](https://rust-lang.github.io/rustc-dev-guide/mir/index.html). ## Do I need to attend any meetings? We don't have any meetings yet. \ No newline at end of file diff --git a/content/working-groups/nll/_index.md b/content/working-groups/nll/_index.md index bc03cd93..1fc38c2a 100644 --- a/content/working-groups/nll/_index.md +++ b/content/working-groups/nll/_index.md @@ -53,9 +53,9 @@ and context: - MIR is an intermediate representation used within the compiler. NLL is implemented as a new borrow checker implemented on the MIR. You can read about the MIR in - the [relevant rustc-guide chapter](https://rust-lang.github.io/rustc-guide/mir/index.html). + the [relevant rustc-dev-guide chapter](https://rust-lang.github.io/rustc-dev-guide/mir/index.html). - You can read about the major phases and internals of the MIR borrow checker in - it's [rustc-guide chapter](https://rust-lang.github.io/rustc-guide/borrow_check.html). + it's [rustc-dev-guide chapter](https://rust-lang.github.io/rustc-dev-guide/borrow_check.html). - NLL was originally specified in [RFC 2094](https://github.com/rust-lang/rfcs/blob/master/text/2094-nll.md). - [@nikomatsakis][nikomatsakis]'s blog posts on NLL are also useful for getting familiar with the diff --git a/content/working-groups/parallel-rustc/_index.md b/content/working-groups/parallel-rustc/_index.md index d44f89a7..1492b8d7 100644 --- a/content/working-groups/parallel-rustc/_index.md +++ b/content/working-groups/parallel-rustc/_index.md @@ -21,9 +21,9 @@ This working group aims to accomplish the following: - Finish, optimize, and test the implementation of parallel compilation to an extent that allows making it the default. - Produce solid documentation of how parallel evaluation works, how it is - implementated, and what things it might affect in the [rustc-guide][rustc-guide]. + implementated, and what things it might affect in the [rustc-dev-guide][rustc-dev-guide]. -[rustc-guide]: https://rust-lang.github.io/rustc-guide/ +[rustc-dev-guide]: https://rust-lang.github.io/rustc-dev-guide/ # How can I get involved? If you are interested in getting involved in this working group, you are welcome to diff --git a/content/working-groups/rfc-2229/_index.md b/content/working-groups/rfc-2229/_index.md index 161da65b..e0707a53 100644 --- a/content/working-groups/rfc-2229/_index.md +++ b/content/working-groups/rfc-2229/_index.md @@ -43,7 +43,7 @@ This working group aims to accomplish the following: entire individual variables, instead capture the actual path to fields of the variable, that is used. This helps to eliminate borrow check errors. - Produce documentation of how the closures in Rust are implemented in the - [rustc-guide] along the way. Currently, the rustc guide does not have a + [rustc-dev-guide] along the way. Currently, the rustc guide does not have a section on closures. We would like to change it. # How can I get involved? @@ -62,17 +62,17 @@ can be found [here][playlist]. ## Can I contribute in ways other than code ? Definitely, you can. If you would like to have a deep understanding of closures -but don't intend to write any code, help us add a section to the [rustc-guide]. +but don't intend to write any code, help us add a section to the [rustc-dev-guide]. One way to do that will be to watch these [videos][playlist] and to summarize the closure implementation details discussed there in a new closure section of -the rustc-guide. +the rustc-dev-guide. # Roadmap The project roadmap can be found [here][roadmap]. [Niko]: https://github.com/nikomatsakis [Blitzerr]: https://github.com/blitzerr -[rustc-guide]: https://rust-lang.github.io/rustc-guide/ +[rustc-dev-guide]: https://rust-lang.github.io/rustc-dev-guide/ [repo]: https://github.com/rust-lang/rust [zulip]: https://rust-lang.zulipchat.com/#narrow/stream/189812-t-compiler.2Fwg-rfc-2229 [RFC-2229]: https://github.com/rust-lang/rfcs/blob/master/text/2229-capture-disjoint-fields.md diff --git a/content/working-groups/template/_index.md b/content/working-groups/template/_index.md index 77959398..cc068230 100644 --- a/content/working-groups/template/_index.md +++ b/content/working-groups/template/_index.md @@ -51,9 +51,9 @@ and context: - MIR is an intermediate representation used within the compiler. NLL is implemented as a new borrow checker implemented on the MIR. You can read about the MIR in - the [relevant rustc-guide chapter](https://rust-lang.github.io/rustc-guide/mir/index.html). + the [relevant rustc-dev-guide chapter](https://rust-lang.github.io/rustc-dev-guide/mir/index.html). - You can read about the major phases and internals of the MIR borrow checker in - it's [rustc-guide chapter](https://rust-lang.github.io/rustc-guide/borrow_check.html). + it's [rustc-dev-guide chapter](https://rust-lang.github.io/rustc-dev-guide/borrow_check.html). - NLL was originally specified in [RFC 2094](https://github.com/rust-lang/rfcs/blob/master/text/2094-nll.md). - [@nikomatsakis][nikomatsakis]'s blog posts on NLL are also useful for getting familiar with the