Skip to content

Commit

Permalink
Transition rustc-guide to rustc-dev-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
chrissimpkins committed Mar 6, 2020
1 parent 5055322 commit 7e10583
Show file tree
Hide file tree
Showing 33 changed files with 74 additions and 74 deletions.
8 changes: 4 additions & 4 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion content/minutes/design-meeting/2019-07-08-triage-wg.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -143,16 +143,16 @@ 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*
* sometimes it's not possible or desirable to write complete docs before-hand
* 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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/minutes/steering-meeting/2018-10-26.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
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).
6 changes: 3 additions & 3 deletions content/minutes/steering-meeting/2018-12-14.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion content/minutes/steering-meeting/2019-01-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions content/minutes/steering-meeting/2019-03-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/minutes/steering-meeting/2019-04-12.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions content/minutes/triage-meeting/2019-08-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion content/minutes/triage-meeting/2019-10-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions content/minutes/triage-meeting/2019-10-17.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion content/minutes/triage-meeting/2019-10-31.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
6 changes: 3 additions & 3 deletions content/minutes/triage-meeting/2019-12-05.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Loading

0 comments on commit 7e10583

Please sign in to comment.