Go to file

bors f8426e2e21 auto merge of #17288 : alexcrichton/rust/change-snap, r=brson I'm rotating in some CentOS 5.10 bots so we actually build on Linux 2.6.18 like we advertise doing so. Currently the snapshots are incompatible with CentOS 5.10 due to snapshots requiring glibc 2.6 and CentOS 5.10 having glibc 2.5. It turns out that rustc only requires one symbol from glibc 2.6, which is `futimens`. The rust distribution itself does not use this symbol, but LLVM conditionally detects it and then uses it. This symbol isn't even called as part of the compilation process, so we don't even need it! The new snapshot was generated following these instructions [1]: 1. Download the current x86_64 linux snapshot and unpack it. 2. Open the rustc binary in a hex editor. 3. Change the linkage against glibc 2.6 from strong to weak 4. Write changes and re-run src/etc/make-snapshot.py 5. Upload new tarball to S3 On CentOS 5.10 a warning is printed each time the snapshot runs that the symbol cannot be found (anyone with glibc 2.6+ does not have this warning printed). The key part is that we can bootstrap on CentOS 5.10 at this point. The next snapshot will be naturally compatible with glibc 2.3 (even older!) and will not need to be manually edited. [1]: http://jamesbond3142.no-ip.org/wiki/wiki.cgi/NewAppsOnOldGlibc		2014-09-16 02:26:01 +00:00
man	rustc.1: fix typo	2014-07-16 08:01:59 +02:00
mk	auto merge of #17200 : brson/rust/wintrip-w64, r=cmr	2014-09-15 12:56:13 +00:00
src	auto merge of #17288 : alexcrichton/rust/change-snap, r=brson	2014-09-16 02:26:01 +00:00
.gitattributes	webfonts: proper fix	2014-07-08 20:29:36 +02:00
.gitignore	gitignore: Add the autogenerated/downloaded unicode data files.	2014-08-03 17:32:53 +10:00
.gitmodules	add back jemalloc to the tree	2014-05-10 19:58:17 -04:00
.mailmap	.mailmap: tolerate different names, emails in shortlog	2013-06-05 23:26:00 +05:30
.travis.yml	travis: Move from travis_wait to time-passes	2014-07-01 20:21:16 -07:00
AUTHORS.txt	Updated release notes for 0.11.0	2014-06-30 07:25:58 -07:00
configure	Remove build system support for i686-pc-mingw32 triple in favor if i686-w64-mingw32	2014-09-12 10:46:31 -07:00
CONTRIBUTING.md	Make small doc contributions less onerous/intimidating	2014-08-08 19:36:32 -04:00
COPYRIGHT	Update some copyright dates	2014-01-08 18:04:43 -08:00
LICENSE-APACHE	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-MIT	Change the licence holder to The Rust Project Developers	2014-05-03 23:59:24 +02:00
Makefile.in	enable jemalloc debugging in unoptimized builds	2014-09-07 14:23:48 -04:00
README.md	Replace the Tutorial with the Guide.	2014-09-11 16:21:32 -04:00
RELEASES.txt	Update RELEASES.txt	2014-07-05 00:22:59 -04:00

README.md

The Rust Programming Language

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

Quick Start

Download a binary installer for your platform.
Read the guide.
Enjoy!

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

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)
- perl 5.0 or later
- GNU make 3.81 or later
- curl
- git
Download and build Rust:

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

To build from the tarball do:
```
 $ curl -O https://static.rust-lang.org/dist/rust-nightly.tar.gz
 $ tar -xzf rust-nightly.tar.gz
 $ cd rust-nightly
```
Or to build from the repo do:
```
 $ git clone https://github.com/rust-lang/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, and rustdoc, the API-documentation tool.
Read the guide.
Enjoy!

Building on Windows

To easily build on windows we can use MSYS2:

Grab the latest MSYS2 installer and go through the installer.
Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other tools we need.
```
 $ pacman -S mingw-w64-i686-toolchain
 $ pacman -S base-devel
```
With that now start mingw32_shell.bat from where you installed MSYS2 (i.e. C:\msys).
From there just navigate to where you have 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:

Windows (7, 8, Server 2008 R2), x86 only
Linux (2.6.18 or later, various distributions), x86 and x86-64
OSX 10.7 (Lion) 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.

Getting help and getting involved

The Rust community congregates in a few places:

StackOverflow - Get help here.
/r/rust - General discussion.
discuss.rust-lang.org - For development of the Rust language itself.

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.