2012-07-10 00:18:37 -05:00
|
|
|
|
# The Rust Programming Language
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2016-06-27 12:51:27 -05:00
|
|
|
|
This is the main source code repository for [Rust]. It contains the compiler,
|
|
|
|
|
standard library, and documentation.
|
2015-05-15 00:43:40 -05:00
|
|
|
|
|
2015-11-09 15:22:16 -06:00
|
|
|
|
[Rust]: https://www.rust-lang.org
|
2015-06-18 16:48:51 -05:00
|
|
|
|
|
2013-07-18 18:27:43 -05:00
|
|
|
|
## Quick Start
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[quick-start]: #quick-start
|
2012-07-10 00:13:48 -05:00
|
|
|
|
|
2017-06-09 00:37:22 -05:00
|
|
|
|
Read ["Installation"] from [The Book].
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2018-12-10 16:28:55 -06:00
|
|
|
|
["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
|
2015-08-09 16:15:05 -05:00
|
|
|
|
[The Book]: https://doc.rust-lang.org/book/index.html
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
2019-01-18 15:28:23 -06:00
|
|
|
|
## Installing from Source
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[building-from-source]: #building-from-source
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
2019-01-18 15:28:23 -06:00
|
|
|
|
_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._
|
|
|
|
|
|
2017-10-14 16:59:58 -05:00
|
|
|
|
### Building on *nix
|
2014-01-11 08:19:38 -06:00
|
|
|
|
1. Make sure you have installed the dependencies:
|
2015-02-21 16:46:06 -06:00
|
|
|
|
|
2017-03-21 11:26:19 -05:00
|
|
|
|
* `g++` 4.7 or later or `clang++` 3.x or later
|
2016-02-13 14:19:44 -06:00
|
|
|
|
* `python` 2.7 (but not 3.x)
|
2015-02-21 16:46:06 -06:00
|
|
|
|
* GNU `make` 3.81 or later
|
2016-08-16 23:30:17 -05:00
|
|
|
|
* `cmake` 3.4.3 or later
|
2015-02-21 16:46:06 -06:00
|
|
|
|
* `curl`
|
|
|
|
|
* `git`
|
2015-02-13 11:26:44 -06:00
|
|
|
|
|
2015-02-18 15:46:20 -06:00
|
|
|
|
2. Clone the [source] with `git`:
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
2015-02-21 16:46:06 -06:00
|
|
|
|
```sh
|
|
|
|
|
$ git clone https://github.com/rust-lang/rust.git
|
|
|
|
|
$ cd rust
|
|
|
|
|
```
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
2015-02-15 22:20:25 -06:00
|
|
|
|
[source]: https://github.com/rust-lang/rust
|
|
|
|
|
|
|
|
|
|
3. Build and install:
|
2014-01-11 08:19:38 -06:00
|
|
|
|
|
2015-02-21 16:46:06 -06:00
|
|
|
|
```sh
|
2017-05-18 15:48:14 -05:00
|
|
|
|
$ ./x.py build && sudo ./x.py install
|
2015-02-21 16:46:06 -06:00
|
|
|
|
```
|
2014-01-11 08:19:38 -06:00
|
|
|
|
|
2019-03-20 23:21:53 -05:00
|
|
|
|
If after running `sudo ./x.py install` you see an error message like
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
error: failed to load source for a dependency on 'cc'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
then run these two commands and then try `sudo ./x.py install` again:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ cargo install cargo-vendor
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ cargo vendor
|
|
|
|
|
```
|
|
|
|
|
|
2017-02-23 04:45:30 -06:00
|
|
|
|
> ***Note:*** Install locations can be adjusted by copying the config file
|
2017-08-12 00:24:25 -05:00
|
|
|
|
> from `./config.toml.example` to `./config.toml`, and
|
2017-07-03 21:04:57 -05:00
|
|
|
|
> adjusting the `prefix` option under `[install]`. Various other options, such
|
|
|
|
|
> as enabling debug information, are also supported, and are documented in
|
|
|
|
|
> the config file.
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
2017-05-18 15:48:14 -05:00
|
|
|
|
When complete, `sudo ./x.py install` will place several programs into
|
2014-02-02 01:56:55 -06:00
|
|
|
|
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
|
2015-02-15 22:41:16 -06:00
|
|
|
|
API-documentation tool. This install does not include [Cargo],
|
|
|
|
|
Rust's package manager, which you may also want to build.
|
|
|
|
|
|
|
|
|
|
[Cargo]: https://github.com/rust-lang/cargo
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
2014-06-26 19:07:44 -05:00
|
|
|
|
### Building on Windows
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[building-on-windows]: #building-on-windows
|
2014-06-26 19:07:44 -05:00
|
|
|
|
|
2016-01-04 11:33:43 -06: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
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[windows-mingw]: #windows-mingw
|
2016-01-04 11:33:43 -06:00
|
|
|
|
|
2016-06-27 18:02:06 -05:00
|
|
|
|
[MSYS2][msys2] can be used to easily build Rust on Windows:
|
2014-06-26 19:07:44 -05:00
|
|
|
|
|
2016-07-06 13:35:33 -05:00
|
|
|
|
[msys2]: https://msys2.github.io/
|
2014-06-26 19:07:44 -05:00
|
|
|
|
|
2016-06-27 18:02:06 -05:00
|
|
|
|
1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
|
2015-02-21 16:46:06 -06:00
|
|
|
|
|
2016-06-27 18:02:06 -05: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 10:14:11 -05:00
|
|
|
|
|
2016-06-27 18:02:06 -05:00
|
|
|
|
3. From this terminal, install the required tools:
|
2015-03-14 18:09:26 -05:00
|
|
|
|
|
2016-06-09 14:05:46 -05:00
|
|
|
|
```sh
|
2016-06-27 18:02:06 -05:00
|
|
|
|
# Update package mirrors (may be needed if you have a fresh install of MSYS2)
|
|
|
|
|
$ pacman -Sy pacman-mirrors
|
2015-10-20 03:02:19 -05:00
|
|
|
|
|
2016-06-27 18:02:06 -05: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
|
2016-12-21 12:58:46 -06:00
|
|
|
|
# that it is important that you do **not** use the 'python2' and 'cmake'
|
|
|
|
|
# packages from the 'msys2' subsystem. The build has historically been known
|
|
|
|
|
# to fail with these packages.
|
2016-06-27 18:02:06 -05:00
|
|
|
|
$ pacman -S git \
|
|
|
|
|
make \
|
|
|
|
|
diffutils \
|
2016-10-13 21:38:49 -05:00
|
|
|
|
tar \
|
2016-06-27 18:02:06 -05:00
|
|
|
|
mingw-w64-x86_64-python2 \
|
|
|
|
|
mingw-w64-x86_64-cmake \
|
|
|
|
|
mingw-w64-x86_64-gcc
|
2015-02-21 16:46:06 -06:00
|
|
|
|
```
|
2014-06-26 19:07:44 -05:00
|
|
|
|
|
2017-02-23 04:45:30 -06:00
|
|
|
|
4. Navigate to Rust's source code (or clone it), then build it:
|
2014-06-26 19:07:44 -05:00
|
|
|
|
|
2015-02-21 16:46:06 -06:00
|
|
|
|
```sh
|
2017-05-18 15:48:14 -05:00
|
|
|
|
$ ./x.py build && ./x.py install
|
2015-02-21 16:46:06 -06:00
|
|
|
|
```
|
2016-01-04 11:33:43 -06:00
|
|
|
|
|
|
|
|
|
#### MSVC
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[windows-msvc]: #windows-msvc
|
2016-01-04 11:33:43 -06:00
|
|
|
|
|
|
|
|
|
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”
|
2016-07-06 13:35:33 -05:00
|
|
|
|
option.
|
2016-01-04 11:33:43 -06:00
|
|
|
|
|
2016-11-16 14:31:19 -06:00
|
|
|
|
With these dependencies installed, you can build the compiler in a `cmd.exe`
|
|
|
|
|
shell with:
|
2016-01-04 11:33:43 -06:00
|
|
|
|
|
|
|
|
|
```sh
|
2016-11-16 14:31:19 -06:00
|
|
|
|
> python x.py build
|
2016-01-04 11:33:43 -06:00
|
|
|
|
```
|
2014-06-26 19:07:44 -05:00
|
|
|
|
|
2018-06-13 12:23:50 -05:00
|
|
|
|
Currently, building Rust only works with some known versions of Visual Studio. If
|
2016-11-16 14:31:19 -06:00
|
|
|
|
you have a more recent version installed the build system doesn't understand
|
2018-06-13 12:50:50 -05:00
|
|
|
|
then you may need to force rustbuild to use an older version. This can be done
|
2016-07-06 13:35:33 -05:00
|
|
|
|
by manually calling the appropriate vcvars file before running the bootstrap.
|
|
|
|
|
|
2018-09-08 22:02:50 -05:00
|
|
|
|
```batch
|
|
|
|
|
> CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"
|
|
|
|
|
> python x.py build
|
2016-06-27 12:51:27 -05:00
|
|
|
|
```
|
|
|
|
|
|
2017-02-23 04:45:30 -06:00
|
|
|
|
#### Specifying an ABI
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[specifying-an-abi]: #specifying-an-abi
|
2017-02-23 04:45:30 -06:00
|
|
|
|
|
|
|
|
|
Each specific ABI can also be used from either environment (for example, using
|
2018-06-13 12:23:50 -05:00
|
|
|
|
the GNU ABI in PowerShell) by using an explicit build triple. The available
|
2017-02-23 04:45:30 -06: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 13:28:39 -05:00
|
|
|
|
The build triple can be specified by either specifying `--build=<triple>` when
|
2017-02-23 04:45:30 -06:00
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
### Configure and Make
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[configure-and-make]: #configure-and-make
|
2017-02-23 04:45:30 -06:00
|
|
|
|
|
|
|
|
|
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 12:50:50 -05:00
|
|
|
|
When using the configure script, the generated `config.mk` file may override the
|
2017-02-23 04:45:30 -06:00
|
|
|
|
`config.toml` file. To go back to the `config.toml` file, delete the generated
|
|
|
|
|
`config.mk` file.
|
|
|
|
|
|
2015-08-18 12:49:20 -05:00
|
|
|
|
## Building Documentation
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[building-documentation]: #building-documentation
|
2015-08-18 12:49:20 -05:00
|
|
|
|
|
|
|
|
|
If you’d like to build the documentation, it’s almost the same:
|
|
|
|
|
|
|
|
|
|
```sh
|
2017-02-23 04:45:30 -06:00
|
|
|
|
$ ./x.py doc
|
2015-08-18 12:49:20 -05:00
|
|
|
|
```
|
|
|
|
|
|
2017-03-13 00:01:32 -05: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 12:49:20 -05:00
|
|
|
|
|
2013-07-18 18:27:43 -05:00
|
|
|
|
## Notes
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[notes]: #notes
|
2013-07-18 18:27:43 -05:00
|
|
|
|
|
|
|
|
|
Since the Rust compiler is written in Rust, it must be built by a
|
2018-06-13 12:23:50 -05:00
|
|
|
|
precompiled "snapshot" version of itself (made in an earlier stage of
|
2013-07-18 18:27:43 -05:00
|
|
|
|
development). As such, source builds require a connection to the Internet, to
|
2018-06-13 12:50:50 -05:00
|
|
|
|
fetch snapshots, and an OS that can execute the available snapshot binaries.
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2012-10-10 19:56:38 -05:00
|
|
|
|
Snapshot binaries are currently built and tested on several platforms:
|
2012-07-10 00:20:32 -05:00
|
|
|
|
|
2018-12-29 16:15:42 -06:00
|
|
|
|
| Platform / Architecture | x86 | x86_64 |
|
|
|
|
|
|--------------------------|-----|--------|
|
|
|
|
|
| Windows (7, 8, 10, ...) | ✓ | ✓ |
|
|
|
|
|
| Linux (2.6.18 or later) | ✓ | ✓ |
|
|
|
|
|
| OSX (10.7 Lion or later) | ✓ | ✓ |
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
|
You may find that other platforms work, but these are our officially
|
2012-10-10 19:56:38 -05:00
|
|
|
|
supported build environments that are most likely to work.
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2015-02-18 15:48:46 -06:00
|
|
|
|
There is more advice about hacking on Rust in [CONTRIBUTING.md].
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2015-02-18 15:48:46 -06:00
|
|
|
|
[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
|
2012-01-23 15:53:12 -06:00
|
|
|
|
|
2015-02-21 16:46:06 -06:00
|
|
|
|
## Getting Help
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[getting-help]: #getting-help
|
2014-08-22 13:04:35 -05:00
|
|
|
|
|
|
|
|
|
The Rust community congregates in a few places:
|
|
|
|
|
|
2015-02-21 16:46:06 -06:00
|
|
|
|
* [Stack Overflow] - Direct questions about using the language.
|
|
|
|
|
* [users.rust-lang.org] - General discussion and broader questions.
|
2015-01-29 17:49:00 -06:00
|
|
|
|
* [/r/rust] - News and general discussion.
|
2014-08-22 13:04:35 -05:00
|
|
|
|
|
2017-04-19 16:45:48 -05:00
|
|
|
|
[Stack Overflow]: https://stackoverflow.com/questions/tagged/rust
|
|
|
|
|
[/r/rust]: https://reddit.com/r/rust
|
2015-08-09 16:15:05 -05:00
|
|
|
|
[users.rust-lang.org]: https://users.rust-lang.org/
|
2015-02-13 11:26:44 -06:00
|
|
|
|
|
|
|
|
|
## Contributing
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[contributing]: #contributing
|
2015-02-13 11:26:44 -06:00
|
|
|
|
|
2015-03-08 16:37:23 -05:00
|
|
|
|
To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
|
2014-08-22 13:04:35 -05:00
|
|
|
|
|
2015-02-15 22:58:06 -06:00
|
|
|
|
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
|
2016-03-30 21:07:53 -05:00
|
|
|
|
Rust. And a good place to ask for help would be [#rust-beginners].
|
2015-02-15 22:58:06 -06:00
|
|
|
|
|
2018-07-04 17:24:43 -05:00
|
|
|
|
The [rustc guide] might be a good place to start if you want to find out how
|
|
|
|
|
various parts of the compiler work.
|
|
|
|
|
|
|
|
|
|
Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
|
2018-02-23 13:20:56 -06:00
|
|
|
|
|
2015-02-15 22:58:06 -06:00
|
|
|
|
[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
|
2015-02-18 15:46:20 -06:00
|
|
|
|
[#rust]: irc://irc.mozilla.org/rust
|
2016-03-30 21:07:53 -05:00
|
|
|
|
[#rust-beginners]: irc://irc.mozilla.org/rust-beginners
|
2018-11-26 15:03:13 -06:00
|
|
|
|
[rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html
|
2018-07-04 17:24:43 -05:00
|
|
|
|
[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
|
2015-02-15 22:58:06 -06:00
|
|
|
|
|
2012-07-10 00:13:48 -05:00
|
|
|
|
## License
|
2017-09-29 18:19:17 -05:00
|
|
|
|
[license]: #license
|
2012-07-10 00:13:48 -05:00
|
|
|
|
|
2012-12-28 15:40:33 -06: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 00:13:48 -05:00
|
|
|
|
|
2016-06-27 12:51:27 -05:00
|
|
|
|
See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
|
|
|
|
|
[COPYRIGHT](COPYRIGHT) for details.
|
2019-04-06 05:04:06 -05:00
|
|
|
|
|
|
|
|
|
## Trademark
|
|
|
|
|
[trademark]: #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].
|
|
|
|
|
|
|
|
|
|
[media-guide]: https://www.rust-lang.org/policies/media-guide
|