2012-07-10 07:18:37 +02:00
|
|
|
|
# The Rust Programming Language
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2016-06-27 19:51:27 +02:00
|
|
|
|
This is the main source code repository for [Rust]. It contains the compiler,
|
|
|
|
|
standard library, and documentation.
|
2015-05-15 07:43:40 +02:00
|
|
|
|
|
2015-11-09 22:22:16 +01:00
|
|
|
|
[Rust]: https://www.rust-lang.org
|
2015-06-18 23:48:51 +02:00
|
|
|
|
|
2013-07-19 01:27:43 +02:00
|
|
|
|
## Quick Start
|
2012-07-10 07:13:48 +02:00
|
|
|
|
|
2015-02-16 06:20:27 +01:00
|
|
|
|
Read ["Installing Rust"] from [The Book].
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2016-01-29 10:45:37 +01:00
|
|
|
|
["Installing Rust"]: https://doc.rust-lang.org/book/getting-started.html#installing-rust
|
2015-08-09 23:15:05 +02:00
|
|
|
|
[The Book]: https://doc.rust-lang.org/book/index.html
|
2013-07-19 01:27:43 +02:00
|
|
|
|
|
2014-04-03 01:59:39 +02:00
|
|
|
|
## Building from Source
|
2013-07-19 01:27:43 +02:00
|
|
|
|
|
2014-01-11 15:19:38 +01:00
|
|
|
|
1. Make sure you have installed the dependencies:
|
2015-02-21 23:46:06 +01:00
|
|
|
|
|
2017-03-21 17:26:19 +01:00
|
|
|
|
* `g++` 4.7 or later or `clang++` 3.x or later
|
2016-02-13 21:19:44 +01:00
|
|
|
|
* `python` 2.7 (but not 3.x)
|
2015-02-21 23:46:06 +01:00
|
|
|
|
* GNU `make` 3.81 or later
|
2016-08-17 06:30:17 +02:00
|
|
|
|
* `cmake` 3.4.3 or later
|
2015-02-21 23:46:06 +01:00
|
|
|
|
* `curl`
|
|
|
|
|
* `git`
|
2015-02-13 18:26:44 +01:00
|
|
|
|
|
2015-02-18 22:46:20 +01:00
|
|
|
|
2. Clone the [source] with `git`:
|
2013-07-19 01:27:43 +02:00
|
|
|
|
|
2015-02-21 23:46:06 +01:00
|
|
|
|
```sh
|
|
|
|
|
$ git clone https://github.com/rust-lang/rust.git
|
|
|
|
|
$ cd rust
|
|
|
|
|
```
|
2013-07-19 01:27:43 +02:00
|
|
|
|
|
2015-02-16 05:20:25 +01:00
|
|
|
|
[source]: https://github.com/rust-lang/rust
|
|
|
|
|
|
|
|
|
|
3. Build and install:
|
2014-01-11 15:19:38 +01:00
|
|
|
|
|
2015-02-21 23:46:06 +01:00
|
|
|
|
```sh
|
2017-02-23 11:45:30 +01:00
|
|
|
|
$ ./x.py build && sudo ./x.py dist --install
|
2015-02-21 23:46:06 +01:00
|
|
|
|
```
|
2014-01-11 15:19:38 +01:00
|
|
|
|
|
2017-02-23 11:45:30 +01:00
|
|
|
|
> ***Note:*** Install locations can be adjusted by copying the config file
|
|
|
|
|
> from `./src/bootstrap/config.toml.example` to `./config.toml`, and
|
|
|
|
|
> adjusting the `prefix` option under `[install]`. Various other options are
|
|
|
|
|
> also supported, and are documented in the config file.
|
2013-07-19 01:27:43 +02:00
|
|
|
|
|
2017-02-23 11:45:30 +01:00
|
|
|
|
When complete, `sudo ./x.py dist --install` will place several programs into
|
2014-02-02 08:56:55 +01:00
|
|
|
|
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
|
2015-02-16 05:41:16 +01: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-19 01:27:43 +02:00
|
|
|
|
|
2014-06-27 02:07:44 +02:00
|
|
|
|
### Building on Windows
|
|
|
|
|
|
2016-01-04 18:33:43 +01: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-28 01:02:06 +02:00
|
|
|
|
[MSYS2][msys2] can be used to easily build Rust on Windows:
|
2014-06-27 02:07:44 +02:00
|
|
|
|
|
2016-07-06 20:35:33 +02:00
|
|
|
|
[msys2]: https://msys2.github.io/
|
2014-06-27 02:07:44 +02:00
|
|
|
|
|
2016-06-28 01:02:06 +02:00
|
|
|
|
1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
|
2015-02-21 23:46:06 +01:00
|
|
|
|
|
2016-06-28 01:02:06 +02: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 17:14:11 +02:00
|
|
|
|
|
2016-06-28 01:02:06 +02:00
|
|
|
|
3. From this terminal, install the required tools:
|
2015-03-15 00:09:26 +01:00
|
|
|
|
|
2016-06-09 21:05:46 +02:00
|
|
|
|
```sh
|
2016-06-28 01:02:06 +02:00
|
|
|
|
# Update package mirrors (may be needed if you have a fresh install of MSYS2)
|
|
|
|
|
$ pacman -Sy pacman-mirrors
|
2015-10-20 10:02:19 +02:00
|
|
|
|
|
2016-06-28 01:02:06 +02: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 19:58:46 +01: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-28 01:02:06 +02:00
|
|
|
|
$ pacman -S git \
|
|
|
|
|
make \
|
|
|
|
|
diffutils \
|
2016-10-14 04:38:49 +02:00
|
|
|
|
tar \
|
2016-06-28 01:02:06 +02:00
|
|
|
|
mingw-w64-x86_64-python2 \
|
|
|
|
|
mingw-w64-x86_64-cmake \
|
|
|
|
|
mingw-w64-x86_64-gcc
|
2015-02-21 23:46:06 +01:00
|
|
|
|
```
|
2014-06-27 02:07:44 +02:00
|
|
|
|
|
2017-02-23 11:45:30 +01:00
|
|
|
|
4. Navigate to Rust's source code (or clone it), then build it:
|
2014-06-27 02:07:44 +02:00
|
|
|
|
|
2015-02-21 23:46:06 +01:00
|
|
|
|
```sh
|
2017-02-23 11:45:30 +01:00
|
|
|
|
$ ./x.py build && ./x.py dist --install
|
2015-02-21 23:46:06 +01:00
|
|
|
|
```
|
2016-01-04 18:33:43 +01:00
|
|
|
|
|
|
|
|
|
#### 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”
|
2016-07-06 20:35:33 +02:00
|
|
|
|
option.
|
2016-01-04 18:33:43 +01:00
|
|
|
|
|
2016-11-16 21:31:19 +01:00
|
|
|
|
With these dependencies installed, you can build the compiler in a `cmd.exe`
|
|
|
|
|
shell with:
|
2016-01-04 18:33:43 +01:00
|
|
|
|
|
|
|
|
|
```sh
|
2016-11-16 21:31:19 +01:00
|
|
|
|
> python x.py build
|
2016-01-04 18:33:43 +01:00
|
|
|
|
```
|
2014-06-27 02:07:44 +02:00
|
|
|
|
|
2016-11-16 21:31:19 +01:00
|
|
|
|
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
|
2016-07-06 20:35:33 +02:00
|
|
|
|
then 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.
|
|
|
|
|
|
|
|
|
|
```
|
2016-06-27 19:51:27 +02:00
|
|
|
|
CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"
|
2016-10-21 22:18:09 +02:00
|
|
|
|
python x.py build
|
2016-06-27 19:51:27 +02:00
|
|
|
|
```
|
|
|
|
|
|
2017-02-23 11:45:30 +01:00
|
|
|
|
#### 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
|
|
|
|
|
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`
|
|
|
|
|
|
|
|
|
|
The build triple can be specified by either specifying `--build=ABI` 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.
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-06 12:29:52 +01:00
|
|
|
|
When using the configure script, the generated `config.mk` file may override the
|
2017-02-23 11:45:30 +01:00
|
|
|
|
`config.toml` file. To go back to the `config.toml` file, delete the generated
|
|
|
|
|
`config.mk` file.
|
|
|
|
|
|
2015-08-18 19:49:20 +02:00
|
|
|
|
## Building Documentation
|
|
|
|
|
|
|
|
|
|
If you’d like to build the documentation, it’s almost the same:
|
|
|
|
|
|
|
|
|
|
```sh
|
2017-02-23 11:45:30 +01:00
|
|
|
|
$ ./x.py doc
|
2015-08-18 19:49:20 +02:00
|
|
|
|
```
|
|
|
|
|
|
2017-03-13 06:01:32 +01: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 19:49:20 +02:00
|
|
|
|
|
2013-07-19 01:27:43 +02:00
|
|
|
|
## Notes
|
|
|
|
|
|
|
|
|
|
Since the Rust compiler is written in Rust, it must be built by a
|
|
|
|
|
precompiled "snapshot" version of itself (made in an earlier state of
|
|
|
|
|
development). As such, source builds require a connection to the Internet, to
|
|
|
|
|
fetch snapshots, and an OS that can execute the available snapshot binaries.
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2012-10-11 02:56:38 +02:00
|
|
|
|
Snapshot binaries are currently built and tested on several platforms:
|
2012-07-10 07:20:32 +02:00
|
|
|
|
|
2016-09-01 23:42:51 +02:00
|
|
|
|
| Platform / Architecture | x86 | x86_64 |
|
2015-05-12 08:43:58 +02:00
|
|
|
|
|--------------------------------|-----|--------|
|
|
|
|
|
| Windows (7, 8, Server 2008 R2) | ✓ | ✓ |
|
|
|
|
|
| Linux (2.6.18 or later) | ✓ | ✓ |
|
|
|
|
|
| OSX (10.7 Lion or later) | ✓ | ✓ |
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2014-01-11 15:19:38 +01:00
|
|
|
|
You may find that other platforms work, but these are our officially
|
2012-10-11 02:56:38 +02:00
|
|
|
|
supported build environments that are most likely to work.
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2016-06-27 19:51:27 +02:00
|
|
|
|
Rust currently needs between 600MiB and 1.5GiB to build, depending on platform.
|
|
|
|
|
If it hits swap, it will take a very long time to build.
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2015-02-18 22:48:46 +01:00
|
|
|
|
There is more advice about hacking on Rust in [CONTRIBUTING.md].
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2015-02-18 22:48:46 +01:00
|
|
|
|
[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
|
2012-01-23 22:53:12 +01:00
|
|
|
|
|
2015-02-21 23:46:06 +01:00
|
|
|
|
## Getting Help
|
2014-08-22 20:04:35 +02:00
|
|
|
|
|
|
|
|
|
The Rust community congregates in a few places:
|
|
|
|
|
|
2015-02-21 23:46:06 +01:00
|
|
|
|
* [Stack Overflow] - Direct questions about using the language.
|
|
|
|
|
* [users.rust-lang.org] - General discussion and broader questions.
|
2015-01-30 00:49:00 +01:00
|
|
|
|
* [/r/rust] - News and general discussion.
|
2014-08-22 20:04:35 +02:00
|
|
|
|
|
2015-02-21 23:46:06 +01:00
|
|
|
|
[Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
|
2014-08-22 20:04:35 +02:00
|
|
|
|
[/r/rust]: http://reddit.com/r/rust
|
2015-08-09 23:15:05 +02:00
|
|
|
|
[users.rust-lang.org]: https://users.rust-lang.org/
|
2015-02-13 18:26:44 +01:00
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2015-03-08 22:37:23 +01:00
|
|
|
|
To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md).
|
2014-08-22 20:04:35 +02:00
|
|
|
|
|
2015-02-16 05:58:06 +01: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-31 04:07:53 +02:00
|
|
|
|
Rust. And a good place to ask for help would be [#rust-beginners].
|
2015-02-16 05:58:06 +01:00
|
|
|
|
|
|
|
|
|
[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
|
2015-02-18 22:46:20 +01:00
|
|
|
|
[#rust]: irc://irc.mozilla.org/rust
|
2016-03-31 04:07:53 +02:00
|
|
|
|
[#rust-beginners]: irc://irc.mozilla.org/rust-beginners
|
2015-02-16 05:58:06 +01:00
|
|
|
|
|
2012-07-10 07:13:48 +02:00
|
|
|
|
## License
|
|
|
|
|
|
2012-12-28 22:40:33 +01: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 07:13:48 +02:00
|
|
|
|
|
2016-06-27 19:51:27 +02:00
|
|
|
|
See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
|
|
|
|
|
[COPYRIGHT](COPYRIGHT) for details.
|