Empowering everyone to build reliable and efficient software.
Go to file
bors 491bc3568c auto merge of #8745 : brson/rust/metadata, r=cmr
This does two things: 1) stops compressing metadata, 2) stops copying the metadata section, instead holding a reference to the buffer returned by the LLVM section iterator.

Not compressing metadata requires something like 7x the storage space, but makes running tests about 9% faster. This has been a time improvement on all platforms I've tested, including windows. I considered leaving compression as an option but it doesn't seem to be worth the complexity since we don't currently have any use cases where we need to save that space.

In order to avoid copying the metadata section I had to hack up extra::ebml a bit to support unsafe buffers. We should probably move it into librustc so that it can evolve to support the compiler without worrying about having a crummy interface.

r? @graydon
2013-08-25 13:36:14 -07:00
doc Talk about trait bounds in the tutorial. 2013-08-23 19:20:34 -04:00
man Updated rustpkg man page to match 0.7 2013-07-08 23:03:20 +10:00
mk auto merge of #8722 : graydon/rust/2013-08-23-test-shard, r=msullivan 2013-08-24 02:21:27 -07:00
src auto merge of #8745 : brson/rust/metadata, r=cmr 2013-08-25 13:36:14 -07:00
.gitattributes Force line ending of '.in' files in jemalloc to LF 2013-08-24 22:20:20 +05:30
.gitignore Ignore the generated docs for libextra 2013-05-25 17:07:18 +10:00
.gitmodules Update LLVM 2013-08-04 10:58:22 -07:00
.mailmap .mailmap: tolerate different names, emails in shortlog 2013-06-05 23:26:00 +05:30
AUTHORS.txt Update AUTHORS.txt 2013-06-21 00:54:17 -04:00
configure Don't ever compress metadata 2013-08-24 20:57:35 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2013-06-13 15:41:34 -06:00
COPYRIGHT add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
LICENSE-APACHE Update license, add license boilerplate to most files. Remainder will follow. 2012-12-03 17:12:14 -08:00
LICENSE-MIT tidy version numbers and copyright dates 2013-04-01 16:15:49 -07:00
Makefile.in Don't ever compress metadata 2013-08-24 20:57:35 -07:00
README.md Reorganize README to make it more clear. 2013-07-19 20:52:16 -04:00
RELEASES.txt More 0.7 release notes 2013-06-30 15:02:52 -07:00

The Rust Programming Language

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

Quick Start

Windows

  1. Download and use the installer.
  2. Read the tutorial.
  3. Enjoy!

Note: Windows users should read the detailed getting started notes on the wiki. Even when using the binary installer the Windows build requires a MinGW installation, the precise details of which are not discussed here.

Linux / OS X

  1. Install the prerequisites (if not already installed)

    • 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
  2. 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.7.tar.gz
     $ tar -xzf rust-0.7.tar.gz
     $ cd rust-0.7
    

    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
    

    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.

  3. Read the tutorial.

  4. 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 "tier 1" supported build environments that are most likely to work.

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

There is lots 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.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.