├── .github ├── ISSUE_TEMPLATE │ ├── ORGANIZER-REQUEST.yml │ └── TOPIC-PROPOSAL.yml └── workflows │ └── main.yml ├── .gitignore ├── LICENSE ├── README.md ├── book.toml └── src ├── SUMMARY.md ├── about.md ├── coc.md ├── faq.md ├── meetings.md ├── meetings ├── 2021-11-04.md └── how_to_attend.md └── resources.md /.github/ISSUE_TEMPLATE/ORGANIZER-REQUEST.yml: -------------------------------------------------------------------------------- 1 | name: Organizer Request 2 | description: File a request to the organizers 3 | title: "[Request]: " 4 | labels: ["organizer"] 5 | assignees: 6 | - rustc 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Complete this form to make request(s) of the organizers. 12 | - type: input 13 | id: contact 14 | attributes: 15 | label: Contact Details 16 | description: How can we get in touch with you if we need more info? You aren't required to provide your email address. We will only use it to ask about your request if we need clarity. 17 | placeholder: ex. email@example.com 18 | validations: 19 | required: false 20 | - type: textarea 21 | id: request 22 | attributes: 23 | label: Organizer Request 24 | description: Please provide a detailed description of your request. 25 | placeholder: 26 | value: 27 | validations: 28 | required: true 29 | - type: checkboxes 30 | id: terms 31 | attributes: 32 | label: Code of Conduct 33 | description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct) 34 | options: 35 | - label: I agree to follow this project's Code of Conduct 36 | required: true 37 | 38 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/TOPIC-PROPOSAL.yml: -------------------------------------------------------------------------------- 1 | name: Topic Proposal 2 | description: File a proposal for a topic 3 | title: "[Topic]: " 4 | labels: ["proposed topic"] 5 | assignees: 6 | - rustc 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: Thanks for taking the time to offer a topic proposal! 11 | - type: input 12 | id: contact 13 | attributes: 14 | label: Contact Details 15 | description: How can we get in touch with you if we need more info? 16 | placeholder: ex. email@example.com 17 | validations: 18 | required: false 19 | - type: textarea 20 | id: rustc-module 21 | attributes: 22 | label: Which rustc topic would you like to suggest? 23 | description: Also tell us, which rustc module if different from topic? 24 | placeholder: 25 | value: 26 | validations: 27 | required: true 28 | - type: textarea 29 | id: code 30 | attributes: 31 | label: Relevant code file URL 32 | description: Please provide a link to the module. 33 | placeholder: 34 | value: 35 | validations: 36 | required: true 37 | - type: checkboxes 38 | id: terms 39 | attributes: 40 | label: Code of Conduct 41 | description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct) 42 | options: 43 | - label: I agree to follow this project's Code of Conduct 44 | required: true 45 | 46 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Deploy mdBook 2 | on: [push] 3 | jobs: 4 | build: 5 | runs-on: ubuntu-latest 6 | steps: 7 | - uses: actions/checkout@v2 8 | - uses: XAMPPRocky/deploy-mdbook@v1.1 9 | with: 10 | token: ${{ secrets.GITHUB_TOKEN }} 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | book 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rust Code Reading Clubs 2 | 3 | ## rustc edition 4 | -------------------------------------------------------------------------------- /book.toml: -------------------------------------------------------------------------------- 1 | [book] 2 | authors = ["Doc Jones"] 3 | language = "en" 4 | multilingual = false 5 | src = "src" 6 | title = "book" 7 | -------------------------------------------------------------------------------- /src/SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Summary 2 | 3 | - [About](./about.md) 4 | - [Meetings](./meetings.md) 5 | - [How to attend](./meetings/how_to_attend.md) 6 | - [2021-11-04](./meetings/2021-11-04.md) 7 | - [Links and resources](./resources.md) 8 | - [FAQ](./faq.md) 9 | - [Code of conduct](./coc.md) 10 | -------------------------------------------------------------------------------- /src/about.md: -------------------------------------------------------------------------------- 1 | # What is this? 2 | 3 | Ever wanted to understand how [rustc] works? **This club is for you!** Inspired by the very cool [Code Reading Club](https://code-reading.org/), the idea is to get together every few weeks and just spend some time reading the code in [rustc] or other related projects. 4 | 5 | [rustc]: https://github.com/rust-lang/rust 6 | 7 | The way this club works is pretty simple: every other week, we'll get together for 90 minutes and read some part of rustc (or some project related to rustc), and talk about it. Our goal is to walk away with a high-level understanding of how that code works. For more complex parts of the code, we may wind up spending multiple sessions on the same code. 8 | 9 | We'll be following a "semi-structured" reading process: 10 | 11 | * Identify the modules in the code and their purpose. 12 | * Look at the type definitions and try to describe their high-level purpose. 13 | * Identify the most important functions and their purpose. 14 | * Dig into how a few of those functions are actually implemented. 15 | 16 | The meetings will *not* be recorded, but they will be open to anyone. The first meeting of the Rustc Reading Club will be **November 4th, 2021 at 12:00pm US Eastern time**. Hope to see you there! 17 | -------------------------------------------------------------------------------- /src/coc.md: -------------------------------------------------------------------------------- 1 | # Code of conduct 2 | Rust code of conduct 3 | 4 | All participants in the Rust Code Reading Club are expected to observe the [Rust code of conduct](https://www.rust-lang.org/policies/code-of-conduct). 5 | 6 | We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic. 7 | 8 | Please avoid using overtly sexual aliases or other nicknames that might detract from a friendly, safe and welcoming environment for all. 9 | 10 | Please be kind and courteous. There’s no need to be mean or rude. 11 | 12 | Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer. 13 | 14 | Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works. 15 | 16 | We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term “harassment” as including the definition in the [Citizen Code of Conduct](https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don’t tolerate behavior that excludes people in socially marginalized groups. 17 | 18 | Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact the Reading Club organizers immediately. Whether you’re a regular contributor or a newcomer, we care about making this community a safe place for you and we’ve got your back. 19 | 20 | Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome. 21 | 22 | ## Rust Code Reading Club Rules for participation 23 | 24 | Please observe the club rules for participation. 25 | Moderation contact 26 | Please contact the Reading Club organizers. -------------------------------------------------------------------------------- /src/faq.md: -------------------------------------------------------------------------------- 1 | # Frequently asked questions (FAQ) 2 | 3 | ## Who organizes the Rustc Reading Club? 4 | 5 | [doc-jones] and [nikomatsakis]. 6 | 7 | [doc-jones]: https://github.com/doc-jones 8 | [nikomatsakis]: https://github.com/nikomatsakis 9 | 10 | ## Why not record? 11 | 12 | Important that people feel able to ask whatever question they want without that being posted. 13 | 14 | This is not the kind of event you want to watch anyway, trust me, it's not going to be a coherent presentation. 15 | 16 | ## What level of experience should I have to attend? 17 | 18 | You should be reasonably familiar with Rust syntax. You don't have to be an expert on every corner of the language (although learning about the compiler can definitely help to *make* you an expert). 19 | 20 | Familiarity with compiler concepts is helpful but not required. Experience with rustc is of course also helpful but not required. Feel free to ask questions if people are using compiler or rustc jargon that you don't understand! 21 | 22 | That said, we do want to say something up front: if you're not familiar with rustc already, you will definitely have a "jumping into the deep end of the pool" feeling. That's ok -- and guess what, even the people who *are* familiar with rustc will feel that from time to time. Stick it out, ask questions, and you should learn a lot. 23 | 24 | ## I don't understand how rustc works, should I be scared to attend? 25 | 26 | No, you should not. The whole point of this club is for all of us to learn how rustc works together! 27 | 28 | ## I've never written any kind of compiler before. Should I be scared to attend? 29 | 30 | No. A compiler is just a program. If you've written programs before, you are definitely welcome to attend. Feel free to ask questions, too. 31 | 32 | ## "Is it ok if I just show up and listen?" 33 | 34 | Yes, definitely, you will learn a lot, but be aware it's not going to be a coherent presentation with slides. 35 | 36 | ## Are there ways for me to get good background knowledge about rustc before I attend? 37 | 38 | Yes! Check out the [Rustc Dev Guide](https://rustc-dev-guide.rust-lang.org/). 39 | 40 | ## I'm learning so much! Are there ways for me to give back and help others? 41 | 42 | Yes! File PRs to extend the [Rustc Dev Guide](https://github.com/rust-lang/rustc-dev-guide). 43 | 44 | ## I have some ideas for code to read! 45 | 46 | Great! [File an issue] on our repository. 47 | 48 | [file an issue]: https://github.com/rust-code-reading-club/rustc/issues/new/choose 49 | ## I want to help organize! Can I help? 50 | 51 | So excited! Ping us on [Zulip](https://rust-lang.zulipchat.com/#narrow/stream/305296-rustc-reading-club/). 52 | -------------------------------------------------------------------------------- /src/meetings.md: -------------------------------------------------------------------------------- 1 | # Meetings 2 | 3 | This page has information about the code we will be reading in each meeting along with other useful links. If you'd like to attend a meeting, check out the [How to Attend](./meetings/how_to_attend.md) page! -------------------------------------------------------------------------------- /src/meetings/2021-11-04.md: -------------------------------------------------------------------------------- 1 | # 2021-11-04 2 | 3 | * When: 2021-11-04 12:00 - 13:30 US Eastern time [(see in your time zone)](https://everytimezone.com/s/a287d2e5) 4 | * Zoom details: see the [calendar invite](https://calendar.google.com/event?action=TEMPLATE&tmeid=NW40YjQ1a2sxbG00NmV1c2t1ZGVhMmF2aXRfMjAyMTExMDRUMTYwMDAwWiB1anQ0dHI1ZWdmc21lY28wZTVwaTFuOTRkNEBn&tmsrc=ujt4tr5egfsmeco0e5pi1n94d4%40group.calendar.google.com&scp=ALL) 5 | * What will we read: [compiler/rustc_resolve/src](https://github.com/rust-lang/rust/tree/master/compiler/rustc_resolve/src) 6 | 7 | ## Additional Resources 8 | 9 | Should you decide to dive deeper, the following may help you gain more context on how the resolver works and how it fits in the bigger picture. 10 | 11 | * Rustc Dev Guide [Name Resolution chapter](https://rustc-dev-guide.rust-lang.org/name-resolution.html) 12 | * The Reference chapters on [Names and name resolution](https://doc.rust-lang.org/nightly/reference/names.html) 13 | * [RFC 1560](https://github.com/rust-lang/rfcs/blob/master/text/1560-name-resolution.md) on name resolution which includes some guiding principles. 14 | * General introductions: [Name Resolution](https://en.wikipedia.org/wiki/Name_resolution_(programming_languages)), [Scopes](https://en.wikipedia.org/wiki/Scope_(computer_science)), [Shadowing](https://en.wikipedia.org/wiki/Variable_shadowing) 15 | -------------------------------------------------------------------------------- /src/meetings/how_to_attend.md: -------------------------------------------------------------------------------- 1 | # How to attend 2 | 3 | Reading sessions are planned for the 1st and 3rd Thursdays of each month. Click the link to copy the [Google calendar for Reading sessions](https://calendar.google.com/calendar/u/0?cid=dWp0NHRyNWVnZnNtZWNvMGU1cGkxbjk0ZDRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ). Each calendar entry contains the Zoom link. 4 | 5 | ## .ics calendar link 6 | 7 | [Calendar for Reading sessions](https://calendar.google.com/calendar/ical/ujt4tr5egfsmeco0e5pi1n94d4%40group.calendar.google.com/public/basic.ics) -------------------------------------------------------------------------------- /src/resources.md: -------------------------------------------------------------------------------- 1 | # Links and Resources 2 | 3 | - The [rustc dev guide] 4 | - [Code coloring tool](https://annotate.code-reading.org/#/) that we use during meetings. 5 | - [Rustc Code Reading Club Calendar](https://calendar.google.com/calendar/u/0?cid=dWp0NHRyNWVnZnNtZWNvMGU1cGkxbjk0ZDRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) 6 | 7 | [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/ 8 | 9 | --------------------------------------------------------------------------------