Rust Search
Find the best content on Rust, curated by the community; a
search engine for Rustaceans.
Getting Started Thank you for your interest in contributing to Rust! There are many ways to contribute, and we appreciate all of them. If this is your first time contributing, the walkthrough chapter can give you a good example of how a typ...
About this guide This guide is meant to help document how rustc – the Rust compiler – works, as well as to help new contributors get involved in rustc development. There are several parts to this guide: 1. Building and debugging rustc: Cont...
How to build and run the compiler For profile = "library" users, or users who use download-rustc = true | "if-unchanged", please be advised that the ./x test library/std flow where download-rustc is active (i.e. no compiler changes) is curr...
Quickstart This is a quickstart guide about getting the compiler running. For more information on the individual steps, see the other pages in this chapter. First, clone the repository: git clone https://github.com/rust-lang/rust.git cd rus...
Prerequisites Dependencies See the rust-lang/rust INSTALL. Hardware You will need an internet connection to build. The bootstrapping process involves updating git submodules and downloading a beta compiler. It doesn't need to be super fast,...
Suggested workflows The full bootstrapping process takes quite a while. Here are some suggestions to make your life easier. Installing a pre-push hook CI will automatically fail your build if it doesn't pass tidy, our internal tool for ensu...
Build distribution artifacts You might want to build and package up the compiler for distribution. You’ll want to run this command to do it: ./x dist Install from source You might want to prefer installing Rust (and tools configured in your...
Building documentation This chapter describes how to build documentation of toolchain components, like the standard library (std) or the compiler (rustc). • Document everything This uses rustdoc from the beta toolchain, so will produce (sli...
Rustdoc overview rustdoc lives in-tree with the compiler and standard library. This chapter is about how it works. For information about Rustdoc's features and how to use them, see the Rustdoc book. For more details about how rustdoc works,...
Adding a new target These are a set of steps to add support for a new target. There are numerous end states and paths to get there, so not all sections may be relevant to your desired goal. See also the associated documentation in the targe...
Optimized build of the compiler There are multiple additional build configuration options and techniques that can be used to compile a build of rustc that is as optimized as possible (for example when building rustc for a Linux distribution...
Testing the compiler The Rust project runs a wide variety of different tests, orchestrated by the build system (./x test). This section gives a brief overview of the different testing tools. Subsequent chapters dive into running tests and a...
Running tests You can run the entire test collection using x. But note that running the entire test collection is almost never what you want to do during local development because it takes a really long time. For local development, see the...
Testing with Docker The src/ci/docker directory includes Docker image definitions for Linux-based jobs executed on GitHub Actions (non-Linux jobs run outside Docker). You can run these jobs on your local development machine, which can be he...
Testing with CI The primary goal of our CI system is to ensure that the main branch of rust-lang/rust is always in a valid state by passing our test suite. From a high-level point of view, when you open a pull request at rust-lang/rust, the...
Adding new tests In general, we expect every PR that fixes a bug in rustc to come accompanied by a regression test of some kind. This test should fail in main but pass after the PR. These tests are really useful for preventing us from repea...
Best practices for writing tests This chapter describes best practices related to authoring and modifying tests. We want to make sure the tests we author are easy to understand and modify, even several years later, without needing to consul...
Compiletest Introduction compiletest is the main test harness of the Rust test suite. It allows test authors to organize large numbers of tests (the Rust compiler has many thousands), efficient test execution (parallel execution is supporte...
UI tests UI tests are a particular test suite of compiletest. Introduction The tests in tests/ui are a collection of general-purpose tests which primarily focus on validating the console output of the compiler, but can be used for many othe...
Compiletest directives Directives are special comments that tell compiletest how to build and interpret a test. They may also appear in rmake.rs run-make tests. They are normally put after the short comment that explains the point of this t...
"I think you are inventing provenance for integers. Please, let's not."