6faff24ec8
This PR adds the `rust-lldb` script (feel free to bikeshed about the name). The script will start LLDB and, before doing anything else, load [LLDB type summaries](http://lldb.llvm.org/varformats.html) that will make LLDB print values with Rust syntax. Just use the script like you would normally use LLDB: ``` rust-lldb executable-to-debug --and-any-other-commandline --args ``` The script will just add one additional commandline argument to the LLDB invocation and pass along the rest of the arguments to LLDB after that. Given the following program... ```rust fn main() { let x = Some(1u); let y = [0, 1, 2i]; let z = (x, y); println!("{} {} {}", x, y, z); } ``` ...*without* the 'LLDB type summaries', values will be printed something like this... ``` (lldb) p x (core::option::Option<uint>) $3 = { = (RUST$ENUM$DISR = Some) = (RUST$ENUM$DISR = Some, 1) } (lldb) p y (long [3]) $4 = ([0] = 0, [1] = 1, [2] = 2) (lldb) p z ((core::option::Option<uint>, [int, ..3])) $5 = { = { = (RUST$ENUM$DISR = Some) = (RUST$ENUM$DISR = Some, 1) } = ([0] = 0, [1] = 1, [2] = 2) } ``` ...*with* the 'LLDB type summaries', values will be printed like this: ``` (lldb) p x (core::option::Option<uint>) $0 = Some(1) (lldb) p y (long [3]) $1 = [0, 1, 2] (lldb) p z ((core::option::Option<uint>, [int, ..3])) $2 = (Some(1), [0, 1, 2]) ``` The 'LLDB type summaries' used by the script have been in use for a while in the LLDB autotests but I still consider them to be of alpha-version quality. If you see anything weird when you use them, feel free to file an issue. The script will use whatever Rust "installation" is in PATH, so whichever `rustc` will be called if you type `rustc` into the console, this is the one that the script will ask for the LLDB extension module location. The build system will take care of putting the script and LLDB python module in the right places, whether you want to use the stage1 or stage2 compiler or the one coming with `make install` / `rustup.sh`. Since I don't have much experience with the build system, Makefiles and shell scripts, please look these changes over carefully.
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 using Rust on Windows notes on the wiki.
Building from Source
-
Make sure you have installed the dependencies:
g++4.7 orclang++3.xpython2.6 or later (but not 3.x)perl5.0 or later- GNU
make3.81 or later curlgit
-
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-nightlyOr to build from the repo do:
$ git clone https://github.com/rust-lang/rust.git $ cd rustNow that you have Rust's source code, you can configure and build it:
$ ./configure $ make && make installNote: You may need to use
sudo make installif you do not normally have permission to modify the destination directory. The install locations can be adjusted by passing a--prefixargument toconfigure. Various other options are also supported, pass--helpfor more information on them.When complete,
make installwill place several programs into/usr/local/bin:rustc, the Rust compiler, andrustdoc, 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.batfrom 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 and x86-64 (64-bit support added in Rust 0.12.0)
- 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.
See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.