Empowering everyone to build reliable and efficient software.
Go to file
bors b3d50fc2c0 auto merge of #9015 : MicahChalmer/rust/emacs-fixes-round-2, r=nikomatsakis
Here are fixes for more problems mentioned in #8787.  I think I've addressed everything mentioned there except for @nikomatsakis's comment about match/patterns now.  (This also fixes the bug in struct alignment that @pnkfelix mentioned from my earlier pull request #8872.)

The biggest change here is to make fill-paragraph (M-q) and auto-fill-mode work inside different variations of multi-line and doc comments.  Because of the way emacs paragraph fills work (callbacks interacting with global regexp variables that are used in odd ways) there were quite a few edge cases that I had to work around.

The only way I was able to keep it all straight was to create some regression tests.  They use the emacs lisp regression testing tool ERT, and are included as the last commit here.  I added a few tests for indentation as well.  I have not attempted to integrate the tests into the overall rust compiler build process, since I can't imagine anyone would want the compiler build to have a dependency on emacs.  Maybe at some point tools like this get their own repositories?  Just a thought.

One other thought related to the tests: should there be a place to put these types of style samples that isn't specific to one text editor?  Maybe as part of an official rust style guide, but in a form that would allow tools like this to pull out the samples and use them for tests?
2013-09-07 16:10:58 -07:00
doc Fix #6031. Allow symbolic log levels, not just numbers. 2013-09-06 23:30:17 -04:00
man Updated rustpkg man page to match 0.7 2013-07-08 23:03:20 +10:00
mk Run gyp with CFG_PYTHON which is python < 3 2013-09-07 10:22:36 -07:00
src auto merge of #9015 : MicahChalmer/rust/emacs-fixes-round-2, r=nikomatsakis 2013-09-07 16:10:58 -07:00
.gitattributes Force line ending of '.in' files in jemalloc to LF 2013-08-24 22:20:20 +05:30
.gitignore Ignore the generated docs for libextra 2013-05-25 17:07:18 +10:00
.gitmodules Upgrade libuv to the current master (again) 2013-09-06 11:12:49 -07:00
.mailmap .mailmap: tolerate different names, emails in shortlog 2013-06-05 23:26:00 +05:30
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 Update CONTRIBUTING.md 2013-06-13 15:41:34 -06: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 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

The Rust Programming Language

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

Quick Start

Windows

  1. Download and use the installer.
  2. Read the tutorial.
  3. 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

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

  3. Read the tutorial.

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

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.