[Rust]: https://www.rust-lang.org
+**Note: this README is for _users_ rather than _contributors_.
+If you wish to _contribute_ to the compiler, you should read the
+[Getting Started][gettingstarted] section of the rustc-dev-guide instead.
+You can ask for help in the [#new members Zulip stream][new-members].**
+
+[new-members]: https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members
+
## Quick Start
-[quick-start]: #quick-start
Read ["Installation"] from [The Book].
[The Book]: https://doc.rust-lang.org/book/index.html
## Installing from Source
-[building-from-source]: #building-from-source
-_Note: If you wish to contribute to the compiler, you should read
-[this chapter](https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html)
-of the rustc-guide instead._
+The Rust build system uses a Python script called `x.py` to build the compiler,
+which manages the bootstrapping process. It lives in the root of the project.
+
+The `x.py` command can be run directly on most systems in the following format:
+
+```sh
+./x.py <subcommand> [flags]
+```
+
+This is how the documentation and examples assume you are running `x.py`.
+
+Systems such as Ubuntu 20.04 LTS do not create the necessary `python` command by default when Python is installed that allows `x.py` to be run directly. In that case you can either create a symlink for `python` (Ubuntu provides the `python-is-python3` package for this), or run `x.py` using Python itself:
+
+```sh
+# Python 3
+python3 x.py <subcommand> [flags]
-### Building on *nix
+# Python 2.7
+python2.7 x.py <subcommand> [flags]
+```
+
+More information about `x.py` can be found
+by running it with the `--help` flag or reading the [rustc dev guide][rustcguidebuild].
+
+[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
+[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
+
+### Building on a Unix-like system
1. Make sure you have installed the dependencies:
- * `g++` 4.7 or later or `clang++` 3.x or later
- * `python` 2.7 (but not 3.x)
+ * `g++` 5.1 or later or `clang++` 3.5 or later
+ * `python` 3 or 2.7
* GNU `make` 3.81 or later
- * `cmake` 3.4.3 or later
+ * `cmake` 3.13.4 or later
+ * `ninja`
* `curl`
* `git`
+ * `ssl` which comes in `libssl-dev` or `openssl-devel`
+ * `pkg-config` if you are compiling on Linux and targeting Linux
2. Clone the [source] with `git`:
```sh
- $ git clone https://github.com/rust-lang/rust.git
- $ cd rust
+ git clone https://github.com/rust-lang/rust.git
+ cd rust
```
[source]: https://github.com/rust-lang/rust
-3. Build and install:
+3. Configure the build settings:
+
+ The Rust build system uses a file named `config.toml` in the root of the
+ source tree to determine various configuration settings for the build.
+ Copy the default `config.toml.example` to `config.toml` to get started.
```sh
- $ ./x.py build && sudo ./x.py install
+ cp config.toml.example config.toml
```
- If after running `sudo ./x.py install` you see an error message like
+ If you plan to use `x.py install` to create an installation, it is recommended
+ that you set the `prefix` value in the `[install]` section to a directory.
- ```
- error: failed to load source for a dependency on 'cc'
- ```
+ Create install directory if you are not installing in default directory
- then run these two commands and then try `sudo ./x.py install` again:
+4. Build and install:
- ```
- $ cargo install cargo-vendor
- ```
-
- ```
- $ cargo vendor
+ ```sh
+ ./x.py build && ./x.py install
```
- > ***Note:*** Install locations can be adjusted by copying the config file
- > from `./config.toml.example` to `./config.toml`, and
- > adjusting the `prefix` option under `[install]`. Various other options, such
- > as enabling debug information, are also supported, and are documented in
- > the config file.
-
- When complete, `sudo ./x.py install` will place several programs into
- `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
+ When complete, `./x.py install` will place several programs into
+ `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
API-documentation tool. This install does not include [Cargo],
- Rust's package manager, which you may also want to build.
+ Rust's package manager. To build and install Cargo, you may
+ run `./x.py install cargo` or set the `build.extended` key in
+ `config.toml` to `true` to build and install all tools.
[Cargo]: https://github.com/rust-lang/cargo
### Building on Windows
-[building-on-windows]: #building-on-windows
There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust
build.
#### MinGW
-[windows-mingw]: #windows-mingw
[MSYS2][msys2] can be used to easily build Rust on Windows:
-[msys2]: https://msys2.github.io/
+[msys2]: https://www.msys2.org/
1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
```sh
# Update package mirrors (may be needed if you have a fresh install of MSYS2)
- $ pacman -Sy pacman-mirrors
+ pacman -Sy pacman-mirrors
# Install build tools needed for Rust. If you're building a 32-bit compiler,
# then replace "x86_64" below with "i686". If you've already got git, python,
# or CMake installed and in PATH you can remove them from this list. Note
- # that it is important that you do **not** use the 'python2' and 'cmake'
+ # that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
# packages from the 'msys2' subsystem. The build has historically been known
# to fail with these packages.
- $ pacman -S git \
+ pacman -S git \
make \
diffutils \
tar \
- mingw-w64-x86_64-python2 \
+ mingw-w64-x86_64-python \
mingw-w64-x86_64-cmake \
- mingw-w64-x86_64-gcc
+ mingw-w64-x86_64-gcc \
+ mingw-w64-x86_64-ninja
```
4. Navigate to Rust's source code (or clone it), then build it:
```sh
- $ ./x.py build && ./x.py install
+ ./x.py build && ./x.py install
```
#### MSVC
-[windows-msvc]: #windows-msvc
-MSVC builds of Rust additionally require an installation of Visual Studio 2013
-(or later) so `rustc` can use its linker. Make sure to check the “C++ tools”
-option.
+MSVC builds of Rust additionally require an installation of Visual Studio 2017
+(or later) so `rustc` can use its linker. The simplest way is to get the
+[Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
+
+[Visual Studio]: https://visualstudio.microsoft.com/downloads/
+
+(If you're installing cmake yourself, be careful that “C++ CMake tools for
+Windows” doesn't get included under “Individual components”.)
With these dependencies installed, you can build the compiler in a `cmd.exe`
shell with:
```sh
-> python x.py build
+python x.py build
```
Currently, building Rust only works with some known versions of Visual Studio. If
-you have a more recent version installed the build system doesn't understand
-then you may need to force rustbuild to use an older version. This can be done
+you have a more recent version installed and the build system doesn't understand,
+you may need to force rustbuild to use an older version. This can be done
by manually calling the appropriate vcvars file before running the bootstrap.
```batch
-> CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"
-> python x.py build
+CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
+python x.py build
```
#### Specifying an ABI
-[specifying-an-abi]: #specifying-an-abi
Each specific ABI can also be used from either environment (for example, using
the GNU ABI in PowerShell) by using an explicit build triple. The available
The build triple can be specified by either specifying `--build=<triple>` when
invoking `x.py` commands, or by copying the `config.toml` file (as described
-in Building From Source), and modifying the `build` option under the `[build]`
-section.
+in [Installing From Source](#installing-from-source)), and modifying the
+`build` option under the `[build]` section.
### Configure and Make
-[configure-and-make]: #configure-and-make
While it's not the recommended build system, this project also provides a
configure script and makefile (the latter of which just invokes `x.py`).
```sh
-$ ./configure
-$ make && sudo make install
+./configure
+make && sudo make install
```
When using the configure script, the generated `config.mk` file may override the
`config.mk` file.
## Building Documentation
-[building-documentation]: #building-documentation
If you’d like to build the documentation, it’s almost the same:
```sh
-$ ./x.py doc
+./x.py doc
```
The generated documentation will appear under `doc` in the `build` directory for
`build\x86_64-pc-windows-msvc\doc`.
## Notes
-[notes]: #notes
Since the Rust compiler is written in Rust, it must be built by a
precompiled "snapshot" version of itself (made in an earlier stage of
Snapshot binaries are currently built and tested on several platforms:
-| Platform / Architecture | x86 | x86_64 |
-|--------------------------|-----|--------|
-| Windows (7, 8, 10, ...) | ✓ | ✓ |
-| Linux (2.6.18 or later) | ✓ | ✓ |
-| OSX (10.7 Lion or later) | ✓ | ✓ |
+| Platform / Architecture | x86 | x86_64 |
+|---------------------------------------------|-----|--------|
+| Windows (7, 8, 10, ...) | ✓ | ✓ |
+| Linux (kernel 2.6.32, glibc 2.11 or later) | ✓ | ✓ |
+| macOS (10.7 Lion or later) | (\*) | ✓ |
-You may find that other platforms work, but these are our officially
-supported build environments that are most likely to work.
+(\*): Apple dropped support for running 32-bit binaries starting from macOS 10.15 and iOS 11.
+Due to this decision from Apple, the targets are no longer useful to our users.
+Please read [our blog post][macx32] for more info.
-There is more advice about hacking on Rust in [CONTRIBUTING.md].
+[macx32]: https://blog.rust-lang.org/2020/01/03/reducing-support-for-32-bit-apple-targets.html
-[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
+You may find that other platforms work, but these are our officially
+supported build environments that are most likely to work.
## Getting Help
-[getting-help]: #getting-help
The Rust community congregates in a few places:
[users.rust-lang.org]: https://users.rust-lang.org/
## Contributing
-[contributing]: #contributing
-
-To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
-
-Rust has an [IRC] culture and most real-time collaboration happens in a
-variety of channels on Mozilla's IRC network, irc.mozilla.org. The
-most popular channel is [#rust], a venue for general discussion about
-Rust. And a good place to ask for help would be [#rust-beginners].
-The [rustc guide] might be a good place to start if you want to find out how
-various parts of the compiler work.
+If you are interested in contributing to the Rust project, please take a look
+at the [Getting Started][gettingstarted] guide in the [rustc-dev-guide].
-Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
-
-[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
-[#rust]: irc://irc.mozilla.org/rust
-[#rust-beginners]: irc://irc.mozilla.org/rust-beginners
-[rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html
-[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
+[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org
## License
-[license]: #license
Rust is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various
See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
[COPYRIGHT](COPYRIGHT) for details.
+
+## Trademark
+
+[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
+trademarks and logos (the “Rust Trademarks”).
+
+If you want to use these names or brands, please read the [media guide][media-guide].
+
+Third-party logos may be subject to third-party copyrights and trademarks. See
+[Licenses][policies-licenses] for details.
+
+[rust-foundation]: https://foundation.rust-lang.org/
+[media-guide]: https://www.rust-lang.org/policies/media-guide
+[policies-licenses]: https://www.rust-lang.org/policies/licenses