Go to file

bors 4825db44c8 auto merge of #9012 : alexcrichton/rust/format-args, r=huonw The purpose of this macro is to further reduce the number of allocations which occur when dealing with formatting strings. This macro will perform all of the static analysis necessary to validate that a format string is safe, and then it will wrap up the "format string" into an opaque struct which can then be passed around. Two safe functions are added (write/format) which take this opaque argument structure, unwrap it, and then call the unsafe version of write/format (in an unsafe block). Other than these two functions, it is not intended for anyone to ever look inside this opaque struct. The macro looks a bit odd, but mostly because of rvalue lifetimes this is the only way for it to be safe that I know of. Example use-cases of this are: * third-party libraries can use the default formatting syntax without any forced allocations * the fail!() macro can avoid allocating the format string * the logging macros can avoid allocation any strings I plan on transitioning the standard logging/failing to using these macros soon. This is currently blocking on inner statics being usable in cross-crate situations (still tracking down bugs there), but this will hopefully be coming soon! Additionally, I'd rather settle on a name now than later, so if anyone has a better suggestion other than `format_args`, I'm not attached to the name at all :)		2013-09-12 03:21:08 -07:00
doc	auto merge of #9039 : singingboyo/rust/update-for-expr-docs, r=thestinger	2013-09-11 07:46:04 -07:00
man	Updated rustpkg man page to match 0.7	2013-07-08 23:03:20 +10:00
mk	auto merge of #9033 : alexcrichton/rust/libuv-makefile-dep, r=brson	2013-09-09 11:51:03 -07:00
src	auto merge of #9012 : alexcrichton/rust/format-args, r=huonw	2013-09-12 03:21:08 -07:00
.gitattributes	Force line ending of '.in' files in jemalloc to LF	2013-08-24 22:20:20 +05:30
.gitignore
.gitmodules	Upgrade libuv to the current master (again)	2013-09-06 11:12:49 -07:00
.mailmap
AUTHORS.txt	Update AUTHORS.txt	2013-06-21 00:54:17 -04:00
configure	Be sure to reconfigure LLVM even when relocated	2013-09-06 00:09:36 -07:00
CONTRIBUTING.md
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
Makefile.in	Move the llvm auto-clean stamp into $target/llvm	2013-09-03 23:47:13 -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

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.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.
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.