Go to file

Alex Crichton 2784313344 rustc: Clean up error reporting This commit re-works how the monitor() function works and how it both receives and transmits errors. There are a few cases in which the compiler can abort: 1. A normal compiler error. In this case, the compiler raises a FatalError as the failure value of the task. If this happens, then the monitor task does nothing. It ignores all stderr output of the child task and it also suppresses the failure message of the main task itself. This means that on a normal compiler error just the error message itself is printed. 2. A normal internal compiler error. These are invoked from sess.span_bug() and friends. In these cases, they follow the same path (raising a FatalError), but they will also print an ICE message which has a URL to go report a bug. 3. An actual compiler bug. This happens whenever anything calls fail!() instead of going through the session itself. In this case, we print out stuff about RUST_LOG=2 and we by default capture all stderr and print via warn!() so it's only printed out with the RUST_LOG var set.		2014-01-18 10:49:32 -08:00
doc	auto merge of #11619 : adridu59/rust/patch-md, r=cmr	2014-01-18 09:01:46 -08:00
man
mk	auto merge of #11619 : adridu59/rust/patch-md, r=cmr	2014-01-18 09:01:46 -08:00
src	rustc: Clean up error reporting	2014-01-18 10:49:32 -08:00
.gitattributes
.gitignore	doc: build the docs for librustpkg	2014-01-11 19:13:59 -08:00
.gitmodules	Update submodules to point to rust-lang repos	2014-01-09 20:21:22 -08:00
.mailmap
AUTHORS.txt
configure	Add a configure to disable libstd version injection	2014-01-15 08:22:16 -08:00
CONTRIBUTING.md	Various READMEs and docs cleanup	2014-01-11 19:41:31 +01:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	auto merge of #11590 : vadimcn/rust/llvm-tools, r=alexcrichton	2014-01-16 04:31:52 -08:00
README.md	Various READMEs and docs cleanup	2014-01-11 19:41:31 +01:00
RELEASES.txt

README.md

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Quick Start

Windows

Download and use the installer and MinGW.
Read the tutorial.
Enjoy!

Note: Windows users can read the detailed getting started notes on the wiki.

Linux / OS X

Make sure you have installed the dependencies:
- g++ 4.4 or clang++ 3.x
- python 2.6 or later (but not 3.x)
- perl 5.0 or later
- GNU make 3.81 or later
- curl
Download and build Rust:

You can either download a tarball or build directly from the repo.

To build from the tarball do:
```
 $ curl -O http://static.rust-lang.org/dist/rust-0.9.tar.gz
 $ tar -xzf rust-0.9.tar.gz
 $ cd rust-0.9
```
Or to build from the repo do:
```
 $ git clone https://github.com/mozilla/rust.git
 $ cd rust
```
Now that you have Rust's source code, you can configure and build it:
```
 $ ./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; rustdoc, the API-documentation tool, and rustpkg, the Rust package manager and build system.
Read the tutorial.
Enjoy!

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:

Windows (7, Server 2008 R2), x86 only
Linux (various distributions), x86 and x86-64
OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64

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 a lot more documentation in the wiki.

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.