Go to file

Alex Crichton f9d4149c29 rustc: Update LLVM This commit updates the LLVM submodule in use to the current HEAD of the LLVM repository. This is primarily being done to start picking up unwinding support for MSVC, which is currently unimplemented in the revision of LLVM we are using. Along the way a few changes had to be made: * As usual, lots of C++ debuginfo bindings in LLVM changed, so there were some significant changes to our RustWrapper.cpp * As usual, some pass management changed in LLVM, so clang was re-scrutinized to ensure that we're doing the same thing as clang. * Some optimization options are now passed directly into the `PassManagerBuilder` instead of through CLI switches to LLVM. * The `NoFramePointerElim` option was removed from LLVM, favoring instead the `no-frame-pointer-elim` function attribute instead. Additionally, LLVM has picked up some new optimizations which required fixing an existing soundness hole in the IR we generate. It appears that the current LLVM we use does not expose this hole. When an enum is moved, the previous slot in memory is overwritten with a bit pattern corresponding to "dropped". When the drop glue for this slot is run, however, the switch on the discriminant can often start executing the `unreachable` block of the switch due to the discriminant now being outside the normal range. This was patched over locally for now by having the `unreachable` block just change to a `ret void`.		2015-06-16 22:56:42 -07:00
man
mk	mk: fix the CFG_ENABLE_COMPILER_DOCS spelling	2015-06-03 00:49:47 +03:00
src	rustc: Update LLVM	2015-06-16 22:56:42 -07:00
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml
AUTHORS.txt	Typo fixed in AUTHORS.txt	2015-06-04 13:20:27 +09:00
configure	configure: Fix LLVM output dir on MSVC	2015-06-03 22:08:47 -07:00
CONTRIBUTING.md	Document issue tracker tags	2015-05-28 16:00:04 -07:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in
README.md
RELEASES.md

README.md

The Rust Programming Language

Rust is a systems programming language that is fast, memory safe and multithreaded, but does not employ a garbage collector or otherwise impose significant runtime overhead.

This repo contains the code for rustc, the Rust compiler, as well as standard libraries, tools and documentation for Rust.

Quick Start

Read "Installing Rust" from The Book.

Building from Source

Make sure you have installed the dependencies:
- g++ 4.7 or clang++ 3.x
- python 2.6 or later (but not 3.x)
- GNU make 3.81 or later
- curl
- git

Clone the source with git:

$ git clone https://github.com/rust-lang/rust.git
$ cd rust

Build and install:
```
$ ./configure
$ make && make install
```
Note: You may need to use sudo make install if you do not normally have permission to modify the destination directory. The install locations can be adjusted by passing a --prefix argument to configure. Various other options are also supported – pass --help for more information on them.

When complete, make 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.

Building on Windows

MSYS2 can be used to easily build Rust on Windows:

Grab the latest MSYS2 installer and go through the installer.

From the MSYS2 terminal, install the mingw64 toolchain and other required tools.

# Choose one based on platform:
$ pacman -S mingw-w64-i686-toolchain
$ pacman -S mingw-w64-x86_64-toolchain

$ pacman -S base-devel

Run mingw32_shell.bat or mingw64_shell.bat from wherever you installed MYSY2 (i.e. C:\msys), depending on whether you want 32-bit or 64-bit Rust.
Navigate to Rust's source code, configure and build it:
```
$ ./configure
$ make && make install
```

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.

Snapshot binaries are currently built and tested on several platforms:

Platform \ Architecture	x86	x86_64
Windows (7, 8, Server 2008 R2)	✓	✓
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.

Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is more advice about hacking on Rust in CONTRIBUTING.md.

Getting Help

The Rust community congregates in a few places:

Stack Overflow - Direct questions about using the language.
users.rust-lang.org - General discussion and broader questions.
/r/rust - News and general discussion.

Contributing

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.

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 BSD-like licenses.

README.md Unescape Escape