Skip to content

Commit f1b4877

Browse files
authored
Merge pull request #254 from chrissimpkins/rustc-dev-guide-rename
Transition rustc-guide to rustc-dev-guide
2 parents 5055322 + 61f68b7 commit f1b4877

33 files changed

+76
-76
lines changed

content/_index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ type: docs
77
A home for compiler team planning documents, meeting minutes, and
88
other such things. If you're interested in learning about how
99
**rustc** works -- as well as advice on building the compiler, preparing a PR,
10-
and other similar topics -- check out the [rustc-guide].
10+
and other similar topics -- check out the [rustc-dev-guide].
1111

12-
[rustc-guide]: https://rust-lang.github.io/rustc-guide/
12+
[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
1313

1414
## Quick facts
1515

1616
- **Where to find us:** We are primarily present on [Zulip](about/chat-platform), though some of us also monitor Discord.
1717
- **Want to attend a meeting or follow along?** See the "meeting calendar" section below.
1818
- **Looking for technical information about how the compiler works?**
19-
Check out the [rustc-guide](https://rust-lang-nursery.github.io/rustc-guide/).
19+
Check out the [rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/).
2020

2121
## Meeting Calendar
2222

@@ -73,7 +73,7 @@ Name | Status | Short
7373
[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]
7474
[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]
7575
[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]
76-
[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]
76+
[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]
7777
[Diagnostics](working-groups/diagnostics/) | Active | Use crates.io crates for diagnostics rendering and make emitting diagnostics nicer. | [#t-compiler/wg-diagnostics][diagnostics_stream]
7878
[Polymorphization](working-groups/polymorphization/) | Active | Implement an analysis to detect when functions can remain polymorphic during code generation. | [#t-compiler/wg-polymorphization][polymorphization_stream]
7979
[Profile-Guided Optimization](working-groups/pgo/) | Retired | Implementing profile-guided optimization for rustc | [#t-compiler/wg-profile-guided-optimization][pgo_stream]

content/minutes/design-meeting/2019-07-08-triage-wg.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ assigned to do a preliminary review or fix. We need to improve the
106106
"expert map" to be more complex and also to include "levels of
107107
knowledge". Perhaps rename it to "knowledge map" or something like
108108
that. Also, this can be a great way to figure out things that need to
109-
be added to the rustc-guide.
109+
be added to the rustc-dev-guide.
110110

111111
[expert map]: https://github.com/rust-lang/compiler-team/blob/master/experts/MAP.md
112112

content/minutes/design-meeting/2019-10-11-DepGraph-persistence-PR62038.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Dear @*T-compiler/meeting*,
1313

1414
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.
1515

16-
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.)
16+
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://rustc-dev-guide.rust-lang.org/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.)
1717

1818
## Questions for discussion
1919

@@ -54,5 +54,5 @@ I'd also like to discuss briefly how we should document these changes. We curren
5454
* Conclusion:
5555
* Follow-up meeting to dig into design of #60035 and maybe discuss alternatives
5656
* In parallel, Niko will review #62038 now that he understands roughly what it is trying to do
57-
* We would also want to write docs for rustc-guide
57+
* We would also want to write docs for rustc-dev-guide
5858
* We can figure out how that happens in parallel

content/minutes/design-meeting/2019-12-20-major-change-process.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ We would know the system is working if:
120120
* the only "hard block" would be if you don't have a "partner" or "sponsor" from compiler team
121121
* somewhat analogous to the project group lang team concepts
122122
* reviewer not expected to be a pair programmer
123-
* one possible definition for "what is a major change" might be "what would modify the rustc-guide"
124-
* 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"
123+
* one possible definition for "what is a major change" might be "what would modify the rustc-dev-guide"
124+
* 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"
125125
* what to do with new PRs that don't follow the process?
126126
* should we close them?
127127
* maybe have a canned comment and give them some amount of time
@@ -143,16 +143,16 @@ We would know the system is working if:
143143
* would like to review performance results
144144
* we need a `-Z` flag
145145
* we need docs :)
146-
* final discussion point was about exactly how to handle requests for rustc-guide edits
147-
* 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
146+
* final discussion point was about exactly how to handle requests for rustc-dev-guide edits
147+
* 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
148148
* ideally this would come along with the compiler-team issue
149149
* but maybe it would be more something we wait for until issue is *approved* or, in extreme cases, co-develop with author
150150
* if we want to see more docs, we are going to have to start holding the line *somewhere*
151151
* sometimes it's not possible or desirable to write complete docs before-hand
152152
* details may change through review process
153153
* person may not know enough context to write the docs, need help with that
154154
* but the bar should be that the issue can **explain the change** in sufficient detail for it to be understood
155-
* the *actual* rustc-guide changes themselves can come later
155+
* the *actual* rustc-dev-guide changes themselves can come later
156156
* it may be that the role of the learning wg can be to help with some of that
157157

158158
## Final proposed process
@@ -162,8 +162,8 @@ We would know the system is working if:
162162
* Identify mentors or reviewers, if you are working with one
163163
* There will be some "prototype" to guide people in this
164164
* What is a "major change"?
165-
* something where it would make sense to update rustc-guide
166-
* if rustc-guide doesn't cover this code yet, then you may have to use your imagination about what *ought* to be documented :)
165+
* something where it would make sense to update rustc-dev-guide
166+
* if rustc-dev-guide doesn't cover this code yet, then you may have to use your imagination about what *ought* to be documented :)
167167
* These issues will be reviewed by compiler team members
168168
* Compiler team members and contributors can leave concerns and approvals asynchronously (see below)
169169
* maybe we can make a dedicated Zulip stream where new things get

content/minutes/steering-meeting/2018-10-26.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ We pointed out that when we do our planning at [the next Rust All Hands](https:/
3131

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

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

content/minutes/steering-meeting/2018-12-14.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ experienced](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/su
3535
- 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)
3636
- writing docs can be driven via
3737
[`deny(missing_docs)`](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151781803)
38-
as well as [push to complete the missing rustc-guide
38+
as well as [push to complete the missing rustc-dev-guide
3939
sections](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151781969)
4040
- one problem with writing documentation is that [there always seems
4141
to be something that is higher
@@ -55,11 +55,11 @@ is documented.
5555

5656
- [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):
5757
- 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)
58-
- 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)
58+
- 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)
5959
- some examples where we should do this:
6060
- [end-to-end queries](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151783972)
6161
- [parallel query execution](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784316)
62-
- in terms of the rustc-guide:
62+
- in terms of the rustc-dev-guide:
6363
- 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)
6464
- 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)
6565
- we should [not neglect doc comments](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/subject/steering.20meeting.202018-12-14/near/151784445)

content/minutes/steering-meeting/2019-01-04.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ e.g., rustdoc or RLS.
3737

3838
We discussed some possibler areas for discussion:
3939

40-
- [the rustc-guide](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415509)
40+
- [the rustc-dev-guide](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415509)
4141
- [related work, like RLS, rustdoc,](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415505)
4242
or [cranelift](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415743)
4343
- [mentoring?](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019-01-04/near/154415632)

content/minutes/steering-meeting/2019-03-01.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ responsible for any repository we create in the rust-lang organization.
9292
valuable and should point to the responsible working group.
9393

9494
Changing gears, [@mw][mw] asked if there were any example workflows for handling changes in external
95-
crates to which [@nikomatsakis][nikomatsakis] suggested that a rustc-guide chapter on that and
95+
crates to which [@nikomatsakis][nikomatsakis] suggested that a rustc-dev-guide chapter on that and
9696
how to make local copies for debugging would be necessary. [@davidtwco][davidtwco] asked what
9797
information should be kept in the policy document and what information should be kept in the
98-
rustc-guide. There was some consensus that setting up a new out-of-tree crate is policy and working
98+
rustc-dev-guide. There was some consensus that setting up a new out-of-tree crate is policy and working
9999
with one is for the guide.
100100

101101
[@mw][mw] then raised the question of where consent of compiler team members should be gathered

content/minutes/steering-meeting/2019-04-12.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ wind up detailed enough that [frequent contributors can pick them up
9999
and implement
100100
them](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019.2E04.2E12.20.2358850/near/163195172),
101101
even if the people *making* the design are busy with other things.
102-
Similarly, [design documents can become the basis for rustc-guide
102+
Similarly, [design documents can become the basis for rustc-dev-guide
103103
chapters](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/steering.20meeting.202019.2E04.2E12.20.2358850/near/163195352).
104104

105105
[We plan to flesh out some more details and put this idea into action

content/minutes/triage-meeting/2019-08-15.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ type: docs
1818

1919
### [wg-learning](https://rust-lang.github.io/compiler-team/working-groups/learning/)
2020

21-
wg-learning's objective is to make the compiler easier to learn by ensuring that rustc-guide and api docs are "complete".
21+
wg-learning's objective is to make the compiler easier to learn by ensuring that rustc-dev-guide and api docs are "complete".
2222

2323
Currently they're working on:
2424

2525
1. Getting [video lectures](https://www.youtube.com/watch?v=mAUGvNgZYtw) about parts of the compiler from people who know them
26-
2. Turning existing video lectures into content for the [rustc-guide](https://github.com/rust-lang/rustc-guide)
26+
2. Turning existing video lectures into content for the [rustc-dev-guide](https://github.com/rust-lang/rustc-dev-guide)
2727
3. Triaging and working on issues and pull requests for learning content
2828

2929
Help is always wanted!

content/minutes/triage-meeting/2019-10-10.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type: docs
3939

4040
### [wg-learning](https://rust-lang.github.io/compiler-team/working-groups/learning/)
4141

42-
- `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.
42+
- `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://rustc-dev-guide.rust-lang.org/) chapters.
4343

4444
- Originally, individuals were assigned one or lectures to complete but that hasn't worked very well.
4545

content/minutes/triage-meeting/2019-10-17.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ type: docs
5252

5353
- The [Inside Rust](https://blog.rust-lang.org/inside-rust/index.html) blog has launched.
5454

55-
- The [ICE-Breaker group](https://rust-lang.github.io/rustc-guide/ice-breaker/about.html) has been formed!
55+
- The [ICE-Breaker group](https://rustc-dev-guide.rust-lang.org/ice-breaker/about.html) has been formed!
5656

57-
- The [LLVM ICE-Breaker group](https://rust-lang.github.io/rustc-guide/ice-breaker/llvm.html) is also being formed.
57+
- The [LLVM ICE-Breaker group](https://rustc-dev-guide.rust-lang.org/ice-breaker/llvm.html) is also being formed.
5858

5959
[Link to full conversation](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/weekly.20meeting.202019-10-17.20.2354818/near/178389266)
6060

content/minutes/triage-meeting/2019-10-31.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Rust 1.39 ships on Thursday!
2121

2222
### [wg-pgo](https://rust-lang.github.io/compiler-team/working-groups/pgo/)
2323

24-
- PGO is available in the stable compiler. Docs are in the rustc-guide and the rustc-book
24+
- PGO is available in the stable compiler. Docs are in the rustc-dev-guide and the rustc-book
2525

2626
- Unfortunately we don't observe significant performance gains from applying it (except for tiny synthetic test cases).
2727

content/minutes/triage-meeting/2019-12-05.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Accomplished:
3232

3333
- We have a [PR for the ty chapter][ty_chapter], it summarizes [this lecture][lecture_2].
3434

35-
- 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.
35+
- 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.
3636

3737
Next-steps:
3838

@@ -56,6 +56,6 @@ Next-steps:
5656
[lecture_1]: https://www.youtube.com/watch?v=_muY4HjSqVw
5757
[lecture_2]: https://www.youtube.com/watch?v=c01TsOsr3-c
5858
[meeting]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning/topic/planning.20meeting
59-
[salsa_chapter]: https://github.com/rust-lang/rustc-guide/pull/529
60-
[ty_chapter]: https://github.com/rust-lang/rustc-guide/pull/530
59+
[salsa_chapter]: https://github.com/rust-lang/rustc-dev-guide/pull/529
60+
[ty_chapter]: https://github.com/rust-lang/rustc-dev-guide/pull/530
6161
[wg-learning]: https://rust-lang.github.io/compiler-team/working-groups/learning

0 commit comments

Comments
 (0)