Contributing and Finding Information about rustc

Covers command-line argument conventions, compiler entry points like rustc_driver and rustc_interface, and the design and implementation of errors and lints. 1. [Analysis][p7]: Discusses the analyses that the compiler uses to check various properties of the code and inform later stages of the compile process (e.g., type checking). 1. [Appendices][p9] at the end with useful reference information. There are a few of these with different information, including a glossary. ### Constant change Keep in mind that `rustc` is a real production-quality product, being worked upon continuously by a sizeable set of contributors. As such, it has its fair share of codebase churn and technical debt. In addition, many of the ideas discussed throughout this guide are idealized designs that are not fully realized yet. All this makes keeping this guide completely up to date on everything very hard! The Guide itself is of course open-source as well, and the sources can be found at the [GitHub repository]. If you find any mistakes in the guide, please file an issue about it. Even better, open a PR with a correction! If you do contribute to the guide, please see the corresponding [subsection on writing documentation in this guide]. > “‘All conditioned things are impermanent’ — > when one sees this with wisdom, one turns away from suffering.” > _The Dhammapada, verse 277_ ## Other places to find information You might also find the following sites useful: - This guide contains information about how various parts of the compiler work and how to contribute to the compiler. - [rustc API docs] -- rustdoc documentation for the compiler, devtools, and internal tools - [Forge] -- contains documentation about Rust infrastructure, team procedures, and more - [compiler-team] -- the home-base for the Rust compiler team, with description of the team procedures, active working groups, and the team calendar. - [std-dev-guide] -- a similar guide for developing the standard library. - [The t-compiler zulip][z] - `#contribute` and `#wg-rustup` on [Discord](https://discord.gg/rust-lang). - The [Rust Internals forum][rif], a place to ask questions and discuss Rust's internals - The [Rust reference][rr], even though it doesn't specifically talk about Rust's internals, is a great resource nonetheless - Although out of date, [Tom Lee's great blog article][tlgba] is very helpful - The [Rust Compiler Testing Docs][rctd] - For [@bors], [this cheat sheet][cheatsheet] is helpful - Google is always helpful when programming. You can [search all Rust documentation][gsearchdocs] (the standard library, the compiler, the books, the references, and the guides) to quickly find information about the language and compiler. - You can also use Rustdoc's built-in search feature to find documentation on types and functions within the crates you're looking at. You can also search by type signature! For example, searching for `* -> vec` should find all functions that return a `Vec<T>`. _Hint:_ Find more tips and keyboard shortcuts by typing `?` on any Rustdoc page!

The guide covers command-line arguments, compiler entry points, error and lint design, and compiler analyses. It acknowledges that rustc is continuously evolving, making the guide challenging to keep fully updated. Contributions to the guide are encouraged via GitHub. Additional resources for information include rustc API docs, Forge, compiler-team, std-dev-guide, Zulip channel, Discord channels, Rust Internals forum, Rust reference, blog articles, Rust Compiler Testing Docs, and Google for searching Rust documentation.