Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d109a29

Browse files
committedFeb 25, 2025
rewrite compiler team documentation
1 parent 63195bf commit d109a29

23 files changed

+1258
-1356
lines changed
 

‎book.toml

+9
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,16 @@ curly-quotes = true
4343
"x-py.html" = "https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html"
4444
"compiler/bug-fix-procedure.html" = "https://rustc-dev-guide.rust-lang.org/bug-fix-procedure.html"
4545
"compiler/diagnostic-codes.html" = "https://rustc-dev-guide.rust-lang.org/diagnostics/diagnostic-codes.html"
46+
"compiler/mcp.html" = "https://rustc-dev-guide.rust-lang.org/compiler/proposals-and-stabilization.html"
47+
"compiler/new_option.html" = "https://rustc-dev-guide.rust-lang.org/compiler/proposals-and-stabilization.html"
48+
"compiler/prioritization/priority-levels.html" = "https://rustc-dev-guide.rust-lang.org/compiler/prioritization.html"
49+
"compiler/prioritization/procedure.html" = "https://rustc-dev-guide.rust-lang.org/compiler/prioritization.html"
4650
"compiler/profile-queries.html" = "https://rustc-dev-guide.rust-lang.org/queries/profiling.html"
51+
"compiler/steering-meeting.html" = "https://rustc-dev-guide.rust-lang.org/compiler/meetings.html"
52+
"compiler/steering-meeting/how-to-run-design.html" = "https://rustc-dev-guide.rust-lang.org/compiler/meetings.html"
53+
"compiler/steering-meeting/how-to-run-planning.html" = "https://rustc-dev-guide.rust-lang.org/compiler/meetings.html"
54+
"compiler/steering-meeting/submit.html" = "https://rustc-dev-guide.rust-lang.org/compiler/meetings.html"
55+
"compiler/triage-meeting.html" = "https://rustc-dev-guide.rust-lang.org/compiler/meetings.html"
4756
"chat/index.html" = "/platforms/index.html"
4857
"chat/discord.html" = "/platforms/discord.html"
4958
"github.html" = "/platforms/github.html"

‎src/SUMMARY.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,16 @@
4242
- [GitHub Actions created PR open/closer](./triagebot/bot-pull-requests.md)
4343
- [Community](./community/README.md)
4444
- [Compiler](./compiler/README.md)
45-
- [Cross Compilation](./compiler/cross-compilation/README.md)
46-
- [Windows](./compiler/cross-compilation/windows.md)
45+
- [Calendar](./compiler/calendar.md)
4746
- [Cross-team Collaboration](./compiler/cross-team-collaboration.md)
48-
- [Review policy](./compiler/reviews.md)
49-
- [So you want to add a new option to rustc?](./compiler/new_option.md)
50-
- [Major Change Proposals](./compiler/mcp.md)
47+
- [Meetings](./compiler/meetings.md)
5148
- [Membership](./compiler/membership.md)
52-
- [Prioritization](./compiler/prioritization.md)
53-
- [Procedure](./compiler/prioritization/procedure.md)
54-
- [Priority Levels](./compiler/prioritization/priority-levels.md)
5549
- [Notification groups](./compiler/notification-groups.md)
56-
- [Triage Meeting](./compiler/triage-meeting.md)
57-
- [Steering Meeting](./compiler/steering-meeting.md)
58-
- [Submitting a proposal](./compiler/steering-meeting/submit.md)
59-
- [How to run the planning meeting](./compiler/steering-meeting/how-to-run-planning.md)
60-
- [How to run a design meeting](./compiler/steering-meeting/how-to-run-design.md)
50+
- [Resources](./compiler/resources.md)
51+
- [Review Policy](./compiler/reviews.md)
52+
- [Proposals, Approval and Stabilization](./compiler/proposals-and-stabilization.md)
53+
- [Third-party and Out-of-tree Crates Policy](./compiler/third-party-out-of-tree.md)
54+
- [Triage and Prioritization](./compiler/prioritization.md)
6155
- [crates.io](./crates-io/README.md)
6256
- [Crate removal](./crates-io/crate-removal.md)
6357
- [Database maintenance](./crates-io/db-maintenance.md)

‎src/compiler/README.md

+24-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
# Compiler
2-
This section documents the Rust compiler itself, its APIs, and how to
3-
contribute and provide bug fixes for the compiler.
2+
Rust's compiler team are responsible for maintaining the Rust compiler, improving its performance
3+
and considering the stabilization of compiler features.
44

5-
### External Links
6-
* The [Rustc Dev Guide] documents how the compiler works as well providing helpful
7-
information to help get new contributors involved in the development.
8-
* Rustc's [internal documentation].
9-
* The [Compiler team] website is the home for all of the compiler
10-
team's planning.
11-
* oli-obk's [FIXME page] lists all of the `FIXME` comments in the Rust compiler.
5+
We use the Forge to document the team's processes, policies and working practices, if you'd like to
6+
read about how the compiler works and instructions on how to set up a development environment,
7+
you're looking for the [rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/).
128

13-
14-
[Compiler team]: https://rust-lang.github.io/compiler-team/
15-
[FIXME page]: https://oli-obk.github.io/fixmeh/
16-
[Rustc Dev Guide]: https://rustc-dev-guide.rust-lang.org/
17-
[internal documentation]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
9+
- [Calendar](./calendar.md)
10+
- *How do I subscribe to the compiler team's calendar?*
11+
- [Cross-team Collaboration](./cross-team-collaboration.md)
12+
- *How do I request the help of the compiler team?*
13+
- [Meetings](./meetings.md)
14+
- *What meetings do the compiler team run and how can I attend?*
15+
- [Membership](./membership.md)
16+
- *What is expected of compiler team members and how do I join?*
17+
- [Resources](./resources.md)
18+
- *What useful resources are available for contributors and team members?*
19+
- [Review Policy](./reviews.md)
20+
- *How do I make a contribution which is easy to review? How do I start reviewing as a team member?*
21+
- [Proposals, Approval and Stabilization](./proposals-and-stabilization.md)
22+
- *How do I propose a change to the compiler team? What approval is necessary for my change?*
23+
- [Third-party and Out-of-tree Crates Policy](./third-party-out-of-tree.md)
24+
- *When can I add third-party crates to the compiler? When can I create a out-of-tree crate for
25+
the compiler?*
26+
- [Triage and Prioritization](./prioritization.md)
27+
- *How are compiler issues triaged and prioritized?*

‎src/compiler/calendar.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Calendar
2+
All of the compiler team's calendars are available in the Rust project's
3+
[`rust-lang/calendar`][calendar_repo] repository.
4+
5+
## Adding new events
6+
Any project member can submit a pull request to [add new events][add_event] or
7+
[subcalendars][add_calendar], just assign the compiler team's leads as a reviewer for the pull
8+
request.
9+
10+
## Subscribing to the calendar
11+
The team's calendar is [distributed as an `ics` file][ics] that can be imported into your preferred
12+
calendar application.
13+
14+
> You can copy the calendar link from below:
15+
>
16+
> `https://rust-lang.github.io/calendar/compiler.ics`
17+
>
18+
> Alternative links which do not include working groups are available on the
19+
> [calendar repository][calendar_repo].
20+
21+
- Fastmail
22+
- Open the Settings page. Go to "Calendars" on the left sidebar. Scroll down to the
23+
"Subscriptions" section and paste the link to the [compiler team calendar][ics] into the
24+
field and press "Subscribe to calendar".
25+
- Google Calendar
26+
- Press the "+" icon next to "Other Calendars" in the left sidebar. Select "From URL" and paste
27+
the link to the [compiler team calendar][ics] into the field and press "Add calendar".
28+
- Outlook Web
29+
- Go to the Calendar using the icon on the left sidebar. Select "Add Calendar" on the left and
30+
then "Subscribe from the web", paste the link to the [compiler team calendar][ics] into the
31+
field and press "Import".
32+
33+
If your preferred calendar application isn't listed above, feel free to submit a pull request to
34+
this documentation to add instructions above.
35+
36+
[add_calendar]: https://github.com/rust-lang/calendar?tab=readme-ov-file#how-do-i-add-a-calendar
37+
[add_event]: https://github.com/rust-lang/calendar?tab=readme-ov-file#how-do-i-add-an-event
38+
[calendar_repo]: https://github.com/rust-lang/calendar
39+
[ics]: https://rust-lang.github.io/calendar/compiler.ics

‎src/compiler/cross-compilation/README.md

-2
This file was deleted.

‎src/compiler/cross-compilation/windows.md

-31
This file was deleted.
There was a problem loading the remainder of the diff.

0 commit comments

Comments
 (0)
Failed to load comments.