Go to file

bors 67ed30cd5e auto merge of #9097 : michaelwoerister/rust/namespaces, r=jdm Who would have thought that namespaces are such a can of worms `:P` This is mostly because of some GDB idiosyncrasies (does not use namespace information but linkage-name attributes for displaying items contained in namespaces, also cannot handle functions lexically nested within functions), monomorphization, and information about external items only available from metadata. This pull request tries to tackle the problem anyway: * The `DW_AT_linkage_name` for functions is generated just to make GDB display a proper namespace-enabled function name. To this end, a pseudo-mangled name is generated, not corresponding to the real linkage name. This approach shows some success and could be extended to make GDB also show proper parameter types. * As GDB won't accept subprogram DIEs nested within other subprogram DIEs, the `debuginfo` module now generates a companion namespace for each functions (iff needed). A function `fn abc()` will get a companion namespace with name `abc()`, which contains all items (modules, types, functions) declared within the functions scope. The real, proper solution, in my opinion, would be to faithfully reflect the program's lexical structure within DWARF (which allows arbitrary nesting of DIEs, afaik), but I am not sure LLVM's source level debugging implementation would like that and I am pretty sure GDB won't support this in the foreseeable future. * Monomorphization leads to functions and companion namespaces like `somelib::some_func<int, float>()::some_other_function<bool, bool, bool>()`, which I think is the desired behaviour. There is some design space here, however. Maybe you people prefer `somelib::some_func()::some_other_function<bool, bool, bool>()` or `somelib::some_func()::some_other_function::<int, float, bool, bool, bool>()`. The solution will work for now but there are a few things on my 'far future wish list': * A real specification somewhere, what language constructs are mapped to what DWARF structures. * Proper tests that directly compare the generated DWARF information to the expected results (possibly using something like [pyelftools](https://github.com/eliben/pyelftools) or llvm-dwarfdump) * A unified implementation for crate-local and crate-external items (which would possibly involve beefing up `ast_map::path` and metadata a bit) Any comments are welcome! Closes #1541 Closes #1542 (there might be other issues with function name prettiness, but this specific issue should be fixed) Closes #7715 (source locations for structs and enums are now read correctly from the AST)		2013-09-11 06:26:05 -07:00
doc	rename `std::iterator` to `std::iter`	2013-09-09 03:21:46 -04: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 #9097 : michaelwoerister/rust/namespaces, r=jdm	2013-09-11 06:26:05 -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
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.