commit | dbec74ffa7982de8e066a93969ce70a891d7908b | [log] [tgz] |
---|---|---|
author | bors <bors@rust-lang.org> | Fri Jun 21 03:24:56 2019 +0000 |
committer | bors <bors@rust-lang.org> | Fri Jun 21 03:24:56 2019 +0000 |
tree | b8141a086e004f6d272a96a934405daf3a6e8e71 | |
parent | 9d5b6efdf62dbcd7bdf8e78a5f69c1b6678fd155 [diff] | |
parent | 2dafa91310354fdca43211434878b329c0535f46 [diff] |
Auto merge of #61948 - ehuss:update-mdbook, r=steveklabnik Update mdbook This updates to mdbook 0.3.0. This release includes the following changes: https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-030 One of the biggest changes is the update to pulldown-cmark. This also bumps the submodules (except the nomicon which has some broken links). ## reference 6 commits in f8ae436d936f6f4891d3c1bbb1af5865eb8aeadb..08ae27a4921ca53967656a7391c82f6c0ddd1ccc 2019-05-31 14:59:12 +0200 to 2019-06-17 11:24:13 -0700 - Document `underscore_const_names` (rust-lang-nursery/reference#620) - Describe `#[repr(align(x))]` semantics on `enum`s (rust-lang-nursery/reference#619) - Fix typo in lazy_static example. (rust-lang-nursery/reference#622) - Rust 2015 supports Kleene ? macro operator (rust-lang-nursery/reference#617) - Bitrig support has been removed (rust-lang-nursery/reference#615) - Fix spell error in attributes/diagnostics.md (rust-lang-nursery/reference#614) ## book 8 commits in 62a8c6f25fbd981c80a046f3b04be9684749af3b..9aacfcc4c5b102c8cda195932addefd32fe955d2 2019-05-28 15:48:23 -0400 to 2019-06-16 21:27:26 -0400 - Add a script to help diff rendered books - Update mdbook links (rust-lang/book#1989) - Update for markdown changes. (rust-lang/book#1984) - Make all mentions of crates.io consistent - Propagate corrections made in layout - Add link to Swedish translation - Propagate small edits made in layout - Remove snapshot files that have been checked with layout ## rust-by-example 3 commits in d8eec1dd65470b9a68e80ac1cba8fad0daac4916..b27472962986e85c94f4183b1a6d2207660d3ed6 2019-06-08 10:15:22 -0300 to 2019-06-17 15:52:07 -0300 - Update `macro_rules!` formatting. (rust-lang/rust-by-example#1205) - Add Cargo comment to the `try!` macro example. (rust-lang/rust-by-example#1203) - Fix typo (rust-lang/rust-by-example#1204) ## rustc-guide 15 commits in 3ac9cfc9c9ab2e366feebf18718112737f572352..f55e97c145cf37fd664db2e0e2f2d05df328bf4f 2019-06-02 19:36:58 -0500 to 2019-06-15 17:29:12 -0500 - fix typos - Update for TyCtxt<'a, 'gcx, 'tcx> -> TyCtxt<'tcx>. - fix ci failures, typos, broken links - Some edits to address review comments - Notes about closure de-sugaring - add note about rebuilding llvm - Changes to config.toml require a clean - Fix a few typos in type inference chapter - Add triagebot (rust-lang/rustc-guide#337) - Update how-to-build-and-run.md - Update how-to-build-and-run.md - Update compiler-debugging.md - use debug instead of debuginfo-level - Replaced tabs with spaces - correct indentation ## edition-guide 4 commits in 581c6cccfaf995394ea9dcac362dc8e731c18558..f8072acde5ce29c7570d7986180bbded2d22e287 2019-05-06 12:47:44 -0700 to 2019-06-14 23:27:05 +0200 - Small fixes (rust-lang-nursery/edition-guide#179) - Cleanup unused NLL link (rust-lang-nursery/edition-guide#167) - Part 2: Rust 2015 now supports ? macro rep op (rust-lang-nursery/edition-guide#163) - Part 1: Rust 2015 now supports ? macro rep op (rust-lang-nursery/edition-guide#162) ## embedded-book 1 commits in f0c75b75f9c18537b78f5d17c1015247e9a49c86..ef27b517dcd0b990c888c0d7caeff52a5a115619 2019-06-03 10:49:02 +0000 to 2019-06-18 22:59:47 +0000 - Fix link for more strict commonmark interpretation. (rust-embedded/book#194)
This is the main source code repository for Rust. It contains the compiler, standard library, and documentation.
Read “Installation” from The Book.
Note: If you wish to contribute to the compiler, you should read this chapter of the rustc-guide instead.
Make sure you have installed the dependencies:
g++
4.7 or later or clang++
3.x or laterpython
2.7 (but not 3.x)make
3.81 or latercmake
3.4.3 or latercurl
git
Clone the source with git
:
$ git clone https://github.com/rust-lang/rust.git $ cd rust
Build and install:
$ ./x.py build && sudo ./x.py install
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
Note: Install locations can be adjusted by copying the config file from
./config.toml.example
to./config.toml
, and adjusting theprefix
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 API-documentation tool. This install does not include Cargo, Rust's package manager, which you may also want to build.
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.
MSYS2 can be used to easily build Rust on Windows:
Grab the latest MSYS2 installer and go through the installer.
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)
From this terminal, install the required tools:
# Update package mirrors (may be needed if you have a fresh install of MSYS2) $ 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' # packages from the 'msys2' subsystem. The build has historically been known # to fail with these packages. $ pacman -S git \ make \ diffutils \ tar \ mingw-w64-x86_64-python2 \ mingw-w64-x86_64-cmake \ mingw-w64-x86_64-gcc
Navigate to Rust's source code (or clone it), then build it:
$ ./x.py build && ./x.py install
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.
(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:
> 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 by manually calling the appropriate vcvars file before running the bootstrap.
> CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat" > python x.py build
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:
i686-pc-windows-gnu
x86_64-pc-windows-gnu
i686-pc-windows-msvc
x86_64-pc-windows-msvc
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.
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
).
$ ./configure $ make && sudo make install
When using the configure script, the generated config.mk
file may override the config.toml
file. To go back to the config.toml
file, delete the generated config.mk
file.
If you’d like to build the documentation, it’s almost the same:
$ ./x.py doc
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
.
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 development). As such, source builds require a connection to the Internet, to fetch snapshots, and an OS that can execute the available snapshot binaries.
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) | ✓ | ✓ |
You may find that other platforms work, but these are our officially supported build environments that are most likely to work.
There is more advice about hacking on Rust in CONTRIBUTING.md.
The Rust community congregates in a few places:
To contribute to Rust, please see CONTRIBUTING.
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.
Also, you may find the rustdocs for the compiler itself useful.
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.
See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.
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.
Third-party logos may be subject to third-party copyrights and trademarks. See Licenses for details.