mirror of https://github.com/rust-lang/rust.git synced 2024-12-02 19:53:46 +00:00

Empowering everyone to build reliable and efficient software.

Go to file

bors 6023350082 auto merge of #11017 : alexcrichton/rust/faster-read, r=thestinger We were previously reading metadata via `ar p`, but as learned from rustdoc awhile back, spawning a process to do something is pretty slow. Turns out LLVM has an Archive class to read archives, but it cannot write archives. This commits adds bindings to the read-only version of the LLVM archive class (with a new type that only has a read() method), and then it uses this class when reading the metadata out of rlibs. When you put this in tandem of not compressing the metadata, reading the metadata is 4x faster than it used to be The timings I got for reading metadata from the respective libraries was: libstd-04ff901e-0.9-pre.dylib => 100ms libstd-04ff901e-0.9-pre.rlib => 23ms librustuv-7945354c-0.9-pre.dylib => 4ms librustuv-7945354c-0.9-pre.rlib => 1ms librustc-5b94a16f-0.9-pre.dylib => 87ms librustc-5b94a16f-0.9-pre.rlib => 35ms libextra-a6ebb16f-0.9-pre.dylib => 63ms libextra-a6ebb16f-0.9-pre.rlib => 15ms libsyntax-2e4c0458-0.9-pre.dylib => 86ms libsyntax-2e4c0458-0.9-pre.rlib => 22ms In order to always take advantage of these faster metadata read-times, I sort the files in filesearch based on whether they have an rlib extension or not (prefer all rlib files first). Overall, this halved the compile time for a `fn main() {}` crate from 0.185s to 0.095s on my system (when preferring dynamic linking). Reading metadata is still the slowest pass of the compiler at 0.035s, but it's getting pretty close to linking at 0.021s! The next best optimization is to just not copy the metadata from LLVM because that's the most expensive part of reading metadata right now.		2013-12-20 02:06:34 -08:00
doc	auto merge of #10972 : metajack/rust/pkgid-with-name, r=alexcrichton	2013-12-17 07:41:40 -08:00
man	remove the rusti command	2013-10-16 22:54:38 -04:00
mk	auto merge of #10977 : brson/rust/androidtest, r=brson	2013-12-18 20:06:33 -08:00
src	auto merge of #11017 : alexcrichton/rust/faster-read, r=thestinger	2013-12-20 02:06:34 -08:00
.gitattributes	drop the linenoise library	2013-10-16 22:57:51 -04:00
.gitignore	Remove many false positives from the ctags results	2013-12-20 01:59:01 +11:00
.gitmodules	Point gyp submodule toward github	2013-10-25 20:23:53 -07:00
.mailmap	.mailmap: tolerate different names, emails in shortlog	2013-06-05 23:26:00 +05:30
AUTHORS.txt	Update AUTHORS.txt	2013-09-24 16:26:27 -07:00
configure	llvm: Disable pthread on mingw	2013-12-18 09:48:58 +09:00
CONTRIBUTING.md	syntax: Add the Bug Report HOWTO URL to the ICE message	2013-10-21 12:11:24 -07: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	Register new snapshots	2013-12-07 23:02:39 -08:00
README.md	Update version numbers to 0.8	2013-09-21 16:25:08 -07:00
RELEASES.txt	remove the rusti command	2013-10-16 22:54:38 -04:00

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.