2020-07-19 14:53:37 +00:00
|
|
|
|
<a href = "https://www.rust-lang.org/">
|
2020-06-25 14:03:19 +00:00
|
|
|
|
<img width = "90%" height = "auto" src = "https://img.shields.io/badge/Rust-Programming%20Language-black?style=flat&logo=rust" alt = "The Rust Programming Language">
|
2020-06-25 11:13:27 +00:00
|
|
|
|
</a>
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2016-06-27 17:51:27 +00:00
|
|
|
|
This is the main source code repository for [Rust]. It contains the compiler,
|
2020-07-19 14:53:37 +00:00
|
|
|
|
standard library, and documentation.
|
2015-05-15 05:43:40 +00:00
|
|
|
|
|
2015-11-09 21:22:16 +00:00
|
|
|
|
[Rust]: https://www.rust-lang.org
|
2015-06-18 21:48:51 +00:00
|
|
|
|
|
2020-06-17 19:25:00 +00:00
|
|
|
|
**Note: this README is for _users_ rather than _contributors_.**
|
|
|
|
|
|
2013-07-18 23:27:43 +00:00
|
|
|
|
## Quick Start
|
2012-07-10 05:13:48 +00:00
|
|
|
|
|
2017-06-09 05:37:22 +00:00
|
|
|
|
Read ["Installation"] from [The Book].
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2018-12-10 22:28:55 +00:00
|
|
|
|
["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
|
2015-08-09 21:15:05 +00:00
|
|
|
|
[The Book]: https://doc.rust-lang.org/book/index.html
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2019-01-18 21:28:23 +00:00
|
|
|
|
## Installing from Source
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2020-06-17 19:25:00 +00:00
|
|
|
|
**Note: If you wish to _contribute_ to the compiler, you should read the
|
|
|
|
|
[Getting Started][gettingstarted] of the rustc-dev-guide instead of this
|
|
|
|
|
section.**
|
2019-07-09 23:12:41 +00:00
|
|
|
|
|
2020-06-25 10:59:37 +00:00
|
|
|
|
The Rust build system uses a Python script called `x.py` to build the compiler,
|
2020-07-19 14:53:37 +00:00
|
|
|
|
which manages the bootstrapping process. More information about it can be found
|
2020-06-24 15:39:08 +00:00
|
|
|
|
by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild].
|
2019-07-09 23:12:41 +00:00
|
|
|
|
|
2020-07-03 09:42:12 +00:00
|
|
|
|
[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
|
2020-03-09 21:33:04 +00:00
|
|
|
|
[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html
|
2019-01-18 21:28:23 +00:00
|
|
|
|
|
2020-06-02 14:12:36 +00:00
|
|
|
|
### Building on a Unix-like system
|
2014-01-11 14:19:38 +00:00
|
|
|
|
1. Make sure you have installed the dependencies:
|
2015-02-21 22:46:06 +00:00
|
|
|
|
|
2019-08-31 06:50:02 +00:00
|
|
|
|
* `g++` 5.1 or later or `clang++` 3.5 or later
|
2019-11-21 12:57:40 +00:00
|
|
|
|
* `python` 3 or 2.7
|
2015-02-21 22:46:06 +00:00
|
|
|
|
* GNU `make` 3.81 or later
|
2016-08-17 04:30:17 +00:00
|
|
|
|
* `cmake` 3.4.3 or later
|
2020-07-29 18:37:33 +00:00
|
|
|
|
* `ninja`
|
2015-02-21 22:46:06 +00:00
|
|
|
|
* `curl`
|
|
|
|
|
* `git`
|
2019-09-06 19:54:42 +00:00
|
|
|
|
* `ssl` which comes in `libssl-dev` or `openssl-devel`
|
2019-09-29 15:58:29 +00:00
|
|
|
|
* `pkg-config` if you are compiling on Linux and targeting Linux
|
2015-02-13 17:26:44 +00:00
|
|
|
|
|
2015-02-18 21:46:20 +00:00
|
|
|
|
2. Clone the [source] with `git`:
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```sh
|
|
|
|
|
$ git clone https://github.com/rust-lang/rust.git
|
|
|
|
|
$ cd rust
|
|
|
|
|
```
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2015-02-16 04:20:25 +00:00
|
|
|
|
[source]: https://github.com/rust-lang/rust
|
|
|
|
|
|
2019-07-09 23:12:41 +00:00
|
|
|
|
3. Configure the build settings:
|
2014-01-11 14:19:38 +00:00
|
|
|
|
|
2019-07-09 23:12:41 +00:00
|
|
|
|
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.
|
2019-03-21 04:21:53 +00:00
|
|
|
|
|
2019-07-09 23:12:41 +00:00
|
|
|
|
```sh
|
|
|
|
|
$ cp config.toml.example config.toml
|
2019-03-21 04:21:53 +00:00
|
|
|
|
```
|
|
|
|
|
|
2020-06-24 04:59:35 +00:00
|
|
|
|
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.
|
2019-03-21 04:21:53 +00:00
|
|
|
|
|
2019-09-06 19:54:42 +00:00
|
|
|
|
Create install directory if you are not installing in default directory
|
|
|
|
|
|
2019-07-09 23:12:41 +00:00
|
|
|
|
4. Build and install:
|
2019-03-21 04:21:53 +00:00
|
|
|
|
|
2019-07-09 23:12:41 +00:00
|
|
|
|
```sh
|
|
|
|
|
$ ./x.py build && ./x.py install
|
2019-03-21 04:21:53 +00:00
|
|
|
|
```
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2019-07-09 23:12:41 +00:00
|
|
|
|
When complete, `./x.py install` will place several programs into
|
|
|
|
|
`$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
|
2015-02-16 04:41:16 +00:00
|
|
|
|
API-documentation tool. This install does not include [Cargo],
|
2019-07-09 23:12:41 +00:00
|
|
|
|
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.
|
2015-02-16 04:41:16 +00:00
|
|
|
|
|
|
|
|
|
[Cargo]: https://github.com/rust-lang/cargo
|
2013-07-18 23:27:43 +00:00
|
|
|
|
|
2014-06-27 00:07:44 +00:00
|
|
|
|
### Building on Windows
|
|
|
|
|
|
2016-01-04 17:33:43 +00:00
|
|
|
|
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
|
|
|
|
|
you need depends largely on what C/C++ libraries you want to interoperate with:
|
|
|
|
|
for interop with software produced by Visual Studio use the MSVC build of Rust;
|
|
|
|
|
for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU
|
|
|
|
|
build.
|
|
|
|
|
|
|
|
|
|
#### MinGW
|
|
|
|
|
|
2016-06-27 23:02:06 +00:00
|
|
|
|
[MSYS2][msys2] can be used to easily build Rust on Windows:
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2016-07-06 18:35:33 +00:00
|
|
|
|
[msys2]: https://msys2.github.io/
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2016-06-27 23:02:06 +00:00
|
|
|
|
1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
|
2015-02-21 22:46:06 +00:00
|
|
|
|
|
2016-06-27 23:02:06 +00:00
|
|
|
|
2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
|
|
|
|
|
MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit
|
|
|
|
|
Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
|
|
|
|
|
-mingw32` or `msys2_shell.cmd -mingw64` from the command line instead)
|
2015-10-06 15:14:11 +00:00
|
|
|
|
|
2016-06-27 23:02:06 +00:00
|
|
|
|
3. From this terminal, install the required tools:
|
2015-03-14 23:09:26 +00:00
|
|
|
|
|
2016-06-09 19:05:46 +00:00
|
|
|
|
```sh
|
2016-06-27 23:02:06 +00:00
|
|
|
|
# Update package mirrors (may be needed if you have a fresh install of MSYS2)
|
|
|
|
|
$ pacman -Sy pacman-mirrors
|
2015-10-20 08:02:19 +00:00
|
|
|
|
|
2016-06-27 23:02:06 +00:00
|
|
|
|
# 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
|
2020-08-30 23:22:25 +00:00
|
|
|
|
# that it is important that you do **not** use the 'python2', 'cmake' and 'ninja'
|
2016-12-21 18:58:46 +00:00
|
|
|
|
# packages from the 'msys2' subsystem. The build has historically been known
|
|
|
|
|
# to fail with these packages.
|
2016-06-27 23:02:06 +00:00
|
|
|
|
$ pacman -S git \
|
|
|
|
|
make \
|
|
|
|
|
diffutils \
|
2016-10-14 02:38:49 +00:00
|
|
|
|
tar \
|
2019-11-21 12:57:40 +00:00
|
|
|
|
mingw-w64-x86_64-python \
|
2016-06-27 23:02:06 +00:00
|
|
|
|
mingw-w64-x86_64-cmake \
|
2020-08-30 23:22:25 +00:00
|
|
|
|
mingw-w64-x86_64-gcc \
|
|
|
|
|
mingw-w64-x86_64-ninja
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2017-02-23 10:45:30 +00:00
|
|
|
|
4. Navigate to Rust's source code (or clone it), then build it:
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```sh
|
2017-05-18 20:48:14 +00:00
|
|
|
|
$ ./x.py build && ./x.py install
|
2015-02-21 22:46:06 +00:00
|
|
|
|
```
|
2016-01-04 17:33:43 +00:00
|
|
|
|
|
|
|
|
|
#### MSVC
|
|
|
|
|
|
2019-05-14 04:54:47 +00:00
|
|
|
|
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
|
2019-06-07 14:08:22 +00:00
|
|
|
|
[Visual Studio], check the “C++ build tools” and “Windows 10 SDK” workload.
|
2019-05-14 04:54:47 +00:00
|
|
|
|
|
2019-06-07 16:14:52 +00:00
|
|
|
|
[Visual Studio]: https://visualstudio.microsoft.com/downloads/
|
2019-05-14 04:54:47 +00:00
|
|
|
|
|
2019-05-24 06:40:07 +00:00
|
|
|
|
(If you're installing cmake yourself, be careful that “C++ CMake tools for
|
|
|
|
|
Windows” doesn't get included under “Individual components”.)
|
2016-01-04 17:33:43 +00:00
|
|
|
|
|
2016-11-16 20:31:19 +00:00
|
|
|
|
With these dependencies installed, you can build the compiler in a `cmd.exe`
|
|
|
|
|
shell with:
|
2016-01-04 17:33:43 +00:00
|
|
|
|
|
|
|
|
|
```sh
|
2016-11-16 20:31:19 +00:00
|
|
|
|
> python x.py build
|
2016-01-04 17:33:43 +00:00
|
|
|
|
```
|
2014-06-27 00:07:44 +00:00
|
|
|
|
|
2018-06-13 17:23:50 +00:00
|
|
|
|
Currently, building Rust only works with some known versions of Visual Studio. If
|
2020-06-23 10:41:13 +00:00
|
|
|
|
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
|
2016-07-06 18:35:33 +00:00
|
|
|
|
by manually calling the appropriate vcvars file before running the bootstrap.
|
|
|
|
|
|
2018-09-09 03:02:50 +00:00
|
|
|
|
```batch
|
2019-07-31 03:58:17 +00:00
|
|
|
|
> CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
|
2018-09-09 03:02:50 +00:00
|
|
|
|
> python x.py build
|
2016-06-27 17:51:27 +00:00
|
|
|
|
```
|
|
|
|
|
|
2017-02-23 10:45:30 +00:00
|
|
|
|
#### Specifying an ABI
|
|
|
|
|
|
|
|
|
|
Each specific ABI can also be used from either environment (for example, using
|
2018-06-13 17:23:50 +00:00
|
|
|
|
the GNU ABI in PowerShell) by using an explicit build triple. The available
|
2017-02-23 10:45:30 +00:00
|
|
|
|
Windows build triples are:
|
|
|
|
|
- GNU ABI (using GCC)
|
|
|
|
|
- `i686-pc-windows-gnu`
|
|
|
|
|
- `x86_64-pc-windows-gnu`
|
|
|
|
|
- The MSVC ABI
|
|
|
|
|
- `i686-pc-windows-msvc`
|
|
|
|
|
- `x86_64-pc-windows-msvc`
|
|
|
|
|
|
2017-08-22 18:28:39 +00:00
|
|
|
|
The build triple can be specified by either specifying `--build=<triple>` when
|
2017-02-23 10:45:30 +00:00
|
|
|
|
invoking `x.py` commands, or by copying the `config.toml` file (as described
|
2019-07-09 23:12:41 +00:00
|
|
|
|
in [Installing From Source](#installing-from-source)), and modifying the
|
|
|
|
|
`build` option under the `[build]` section.
|
2017-02-23 10:45:30 +00:00
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
```
|
|
|
|
|
|
2018-06-13 17:50:50 +00:00
|
|
|
|
When using the configure script, the generated `config.mk` file may override the
|
2017-02-23 10:45:30 +00:00
|
|
|
|
`config.toml` file. To go back to the `config.toml` file, delete the generated
|
|
|
|
|
`config.mk` file.
|
|
|
|
|
|
2015-08-18 17:49:20 +00:00
|
|
|
|
## Building Documentation
|
|
|
|
|
|
|
|
|
|
If you’d like to build the documentation, it’s almost the same:
|
|
|
|
|
|
|
|
|
|
```sh
|
2017-02-23 10:45:30 +00:00
|
|
|
|
$ ./x.py doc
|
2015-08-18 17:49:20 +00:00
|
|
|
|
```
|
|
|
|
|
|
2017-03-13 05:01:32 +00:00
|
|
|
|
The generated documentation will appear under `doc` in the `build` directory for
|
|
|
|
|
the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be
|
|
|
|
|
`build\x86_64-pc-windows-msvc\doc`.
|
2015-08-18 17:49:20 +00:00
|
|
|
|
|
2013-07-18 23:27:43 +00:00
|
|
|
|
## Notes
|
|
|
|
|
|
|
|
|
|
Since the Rust compiler is written in Rust, it must be built by a
|
2018-06-13 17:23:50 +00:00
|
|
|
|
precompiled "snapshot" version of itself (made in an earlier stage of
|
2013-07-18 23:27:43 +00:00
|
|
|
|
development). As such, source builds require a connection to the Internet, to
|
2018-06-13 17:50:50 +00:00
|
|
|
|
fetch snapshots, and an OS that can execute the available snapshot binaries.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2012-10-11 00:56:38 +00:00
|
|
|
|
Snapshot binaries are currently built and tested on several platforms:
|
2012-07-10 05:20:32 +00:00
|
|
|
|
|
2020-08-31 14:43:54 +00:00
|
|
|
|
| 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) | ✓ | ✓ |
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2014-01-11 14:19:38 +00:00
|
|
|
|
You may find that other platforms work, but these are our officially
|
2012-10-11 00:56:38 +00:00
|
|
|
|
supported build environments that are most likely to work.
|
2012-01-23 21:53:12 +00:00
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
## Getting Help
|
2014-08-22 18:04:35 +00:00
|
|
|
|
|
|
|
|
|
The Rust community congregates in a few places:
|
|
|
|
|
|
2015-02-21 22:46:06 +00:00
|
|
|
|
* [Stack Overflow] - Direct questions about using the language.
|
|
|
|
|
* [users.rust-lang.org] - General discussion and broader questions.
|
2015-01-29 23:49:00 +00:00
|
|
|
|
* [/r/rust] - News and general discussion.
|
2014-08-22 18:04:35 +00:00
|
|
|
|
|
2017-04-19 21:45:48 +00:00
|
|
|
|
[Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
|
|
|
|
|
[/r/rust]: https://reddit.com/r/rust
|
2015-08-09 21:15:05 +00:00
|
|
|
|
[users.rust-lang.org]: https://users.rust-lang.org/
|
2015-02-13 17:26:44 +00:00
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2020-06-17 19:25:00 +00:00
|
|
|
|
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].
|
2015-02-16 04:58:06 +00:00
|
|
|
|
|
2012-07-10 05:13:48 +00:00
|
|
|
|
## License
|
|
|
|
|
|
2012-12-28 21:40:33 +00:00
|
|
|
|
Rust is primarily distributed under the terms of both the MIT license
|
|
|
|
|
and the Apache License (Version 2.0), with portions covered by various
|
|
|
|
|
BSD-like licenses.
|
2012-07-10 05:13:48 +00:00
|
|
|
|
|
2016-06-27 17:51:27 +00:00
|
|
|
|
See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
|
|
|
|
|
[COPYRIGHT](COPYRIGHT) for details.
|
2019-04-06 10:04:06 +00:00
|
|
|
|
|
|
|
|
|
## Trademark
|
|
|
|
|
|
|
|
|
|
The Rust programming language is an open source, community project governed
|
|
|
|
|
by a core team. It is also sponsored by the Mozilla Foundation (“Mozilla”),
|
|
|
|
|
which 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].
|
|
|
|
|
|
2019-04-12 14:14:21 +00:00
|
|
|
|
Third-party logos may be subject to third-party copyrights and trademarks. See
|
|
|
|
|
[Licenses][policies-licenses] for details.
|
|
|
|
|
|
2019-04-06 10:04:06 +00:00
|
|
|
|
[media-guide]: https://www.rust-lang.org/policies/media-guide
|
2019-04-12 14:14:21 +00:00
|
|
|
|
[policies-licenses]: https://www.rust-lang.org/policies/licenses
|