Go to file

Alex Crichton c2e3aa37da rustdoc: Create anchor pages for primitive types This commit adds support in rustdoc to recognize the `#[doc(primitive = "foo")]` attribute. This attribute indicates that the current module is the "owner" of the primitive type `foo`. For rustdoc, this means that the doc-comment for the module is the doc-comment for the primitive type, plus a signal to all downstream crates that hyperlinks for primitive types will be directed at the crate containing the `#[doc]` directive. Additionally, rustdoc will favor crates closest to the one being documented which "implements the primitive type". For example, documentation of libcore links to libcore for primitive types, but documentation for libstd and beyond all links to libstd for primitive types. This change involves no compiler modifications, it is purely a rustdoc change. The landing pages for the primitive types primarily serve to show a list of implemented traits for the primitive type itself. The primitive types documented includes both strings and slices in a semi-ad-hoc way, but in a way that should provide at least somewhat meaningful documentation. Closes #14474		2014-05-31 21:59:50 -07:00
man	Get rid of the android-cross-path flag to rustc.	2014-05-14 02:16:14 -04:00
mk	Remove libworkcache	2014-05-30 23:44:05 -07:00
src	rustdoc: Create anchor pages for primitive types	2014-05-31 21:59:50 -07:00
.gitattributes	make sure jemalloc valgrind support is enabled	2014-05-11 20:05:22 -04:00
.gitignore	Ignore /build even if it’s a symlink, but only at top-level.	2014-05-30 11:37:31 -07:00
.gitmodules	add back jemalloc to the tree	2014-05-10 19:58:17 -04:00
.mailmap
.travis.yml	Let travis check docs for stage1	2014-03-20 10:20:08 +01:00
AUTHORS.txt	Add Richo Healey to contributors	2014-05-05 20:49:50 -07:00
configure	Don't enable libcpp for llvm by default.	2014-05-28 19:54:58 -07:00
CONTRIBUTING.md	Change static.rust-lang.org to doc.rust-lang.org	2014-05-21 19:55:39 -07:00
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT	Change the licence holder to The Rust Project Developers	2014-05-03 23:59:24 +02:00
Makefile.in	mk: Don't run benchmarks with `make check`	2014-05-15 13:50:14 -07:00
README.md	Change static.rust-lang.org to doc.rust-lang.org	2014-05-21 19:55:39 -07:00
RELEASES.txt	Fix a/an typos	2014-05-01 20:02:11 -05: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 tutorial.
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 http://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/mozilla/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. 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, 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.

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.