Go to file

bors 4252a24ae1 auto merge of #10528 : alexcrichton/rust/static-linking-v2, r=pcwalton In this series of commits, I've implemented static linking for rust. The scheme I implemented was the same as my [mailing list post](https://mail.mozilla.org/pipermail/rust-dev/2013-November/006686.html). The commits have more details to the nitty gritty of what went on. I've rebased this on top of my native mutex pull request (#10479), but I imagine that it will land before this lands, I just wanted to pre-emptively get all the rebase conflicts out of the way (becuase this is reorganizing building librustrt as well). Some contentious points I want to make sure are all good: * I've added more "compiler chooses a default" behavior than I would like, I want to make sure that this is all very clearly outlined in the code, and if not I would like to remove behavior or make it clearer. * I want to make sure that the new "fancy suite" tests are ok (using make/python instead of another rust crate) If we do indeed pursue this, I would be more than willing to write up a document describing how linking in rust works. I believe that this behavior should be very understandable, and the compiler should never hinder someone just because linking is a little fuzzy.		2013-11-30 14:41:40 -08:00
doc	Add generation of static libraries to rustc	2013-11-29 18:36:13 -08:00
man
mk	Test fixes and merge conflicts	2013-11-30 14:34:59 -08:00
src	auto merge of #10528 : alexcrichton/rust/static-linking-v2, r=pcwalton	2013-11-30 14:41:40 -08:00
.gitattributes
.gitignore	Add Window build directory to .gitignore	2013-11-13 21:05:01 -05:00
.gitmodules
.mailmap
AUTHORS.txt
configure	Add generation of static libraries to rustc	2013-11-29 18:36:13 -08:00
CONTRIBUTING.md
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	Statically link librustrt to libstd	2013-11-29 18:36:14 -08:00
README.md
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.
Read the tutorial.
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

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
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.8.tar.gz
 $ tar -xzf rust-0.8.tar.gz
 $ cd rust-0.8
```
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.
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 "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.