rust/src/doc/index.md

% Rust documentation

<!-- Completely hide the TOC and the section numbers -->
<style type="text/css">
#TOC { display: none; }
.header-section-number { display: none; }
li {list-style-type: none; }
</style>

* [The Rust tutorial](tutorial.html)  (* [PDF](tutorial.pdf))
* [The Rust reference manual](rust.html) (* [PDF](rust.pdf))

# Guides

* [Pointers](guide-pointers.html)
* [References and Lifetimes](guide-lifetimes.html)
* [Containers and Iterators](guide-container.html)
* [Tasks and Communication](guide-tasks.html)
* [Foreign Function Interface](guide-ffi.html)
* [Macros](guide-macros.html)
* [Packaging](guide-rustpkg.html)
* [Testing](guide-testing.html)
* [Conditions](guide-conditions.html)
* [Rust's Runtime](guide-runtime.html)

# Libraries

* [The standard library, `libstd`](std/index.html)
* [The extra library, `libextra`](extra/index.html)

* [The M:N runtime library, `libgreen`](green/index.html)
* [The 1:1 runtime library, `libnative`](native/index.html)

* [The Rust libuv library, `librustuv`](rustuv/index.html)
* [The Rust packaging library, `librustpkg`](rustpkg/index.html)

* [The Rust parser, `libsyntax`](syntax/index.html)
* [The Rust compiler, `librustc`](rustc/index.html)

* [The `arena` allocation library](arena/index.html)
* [The `flate` compression library](flate/index.html)
* [The `glob` file path matching library](glob/index.html)
* [The `term` terminal-handling library](term/index.html)

# Tooling

* [The `rustdoc` manual](rustdoc.html)
* [The `rustpkg` manual](rustpkg.html)

# FAQs

* [Language FAQ](complement-lang-faq.html)
* [Project FAQ](complement-project-faq.html)
* [Usage FAQ](complement-usage-faq.html)
* [Code cheatsheet](complement-cheatsheet.html) - "How do I do X?"
* [How to submit a bug report](complement-bugreport.html)

# External resources

* The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - `#rust` on irc.mozilla.org
* The Rust community on [Reddit](http://reddit.com/r/rust)
* The Rust [wiki](http://github.com/mozilla/rust/wiki)
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00			`% Rust documentation`

doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`<!-- Completely hide the TOC and the section numbers -->`
			`<style type="text/css">`
			`#TOC { display: none; }`
			`.header-section-number { display: none; }`
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			`li {list-style-type: none; }`
doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`</style>`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			`* [The Rust tutorial](tutorial.html) (* [PDF](tutorial.pdf))`
			`* [The Rust reference manual](rust.html) (* [PDF](rust.pdf))`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`# Guides`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			`* [Pointers](guide-pointers.html)`
			`* [References and Lifetimes](guide-lifetimes.html)`
			`* [Containers and Iterators](guide-container.html)`
			`* [Tasks and Communication](guide-tasks.html)`
			`* [Foreign Function Interface](guide-ffi.html)`
			`* [Macros](guide-macros.html)`
			`* [Packaging](guide-rustpkg.html)`
			`* [Testing](guide-testing.html)`
			`* [Conditions](guide-conditions.html)`
			`* [Rust's Runtime](guide-runtime.html)`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`# Libraries`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			* [The standard library, `libstd`](std/index.html)
			* [The extra library, `libextra`](extra/index.html)
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 08:19:38 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			* [The M:N runtime library, `libgreen`](green/index.html)
			* [The 1:1 runtime library, `libnative`](native/index.html)
Various READMEs and docs cleanup Noticeably closes #11428. 2014-01-11 08:19:38 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			* [The Rust libuv library, `librustuv`](rustuv/index.html)
			* [The Rust packaging library, `librustpkg`](rustpkg/index.html)
doc: build the docs for librustpkg 2014-01-11 19:23:55 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			* [The Rust parser, `libsyntax`](syntax/index.html)
			* [The Rust compiler, `librustc`](rustc/index.html)
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
extra: move arena to libarena In line with the dissolution of libextra - #8784 - moves arena to its own library libarena. Changes based on PR #11787. Updates .gitignore to ignore doc/arena. 2014-01-28 20:50:05 -06:00			* [The `arena` allocation library](arena/index.html)
Move extra::flate to libflate This is hopefully the beginning of the long-awaited dissolution of libextra. Using the newly created build infrastructure for building libraries, I decided to move the first module out of libextra. While not being a particularly meaty module in and of itself, the flate module is required by rustc and additionally has a native C dependency. I was able to very easily split out the C dependency from rustrt, update librustc, and magically everything gets installed to the right locations and built automatically. This is meant to be a proof-of-concept commit to how easy it is to remove modules from libextra now. I didn't put any effort into modernizing the interface of libflate or updating it other than to remove the one glob import it had. 2014-01-24 23:00:31 -06:00			* [The `flate` compression library](flate/index.html)
extra: move glob to libglob In line with the dissolution of libextra - moves glob to its own library libglob. Changes based on PR #11787. Updates .gitignore to ignore doc/glob. 2014-01-28 20:51:33 -06:00			* [The `glob` file path matching library](glob/index.html)
Move term, terminfo out of extra. cc #8784 2014-01-30 18:15:10 -06:00			* [The `term` terminal-handling library](term/index.html)
Move extra::flate to libflate This is hopefully the beginning of the long-awaited dissolution of libextra. Using the newly created build infrastructure for building libraries, I decided to move the first module out of libextra. While not being a particularly meaty module in and of itself, the flate module is required by rustc and additionally has a native C dependency. I was able to very easily split out the C dependency from rustrt, update librustc, and magically everything gets installed to the right locations and built automatically. This is meant to be a proof-of-concept commit to how easy it is to remove modules from libextra now. I didn't put any effort into modernizing the interface of libflate or updating it other than to remove the one glob import it had. 2014-01-24 23:00:31 -06:00
doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`# Tooling`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			* [The `rustdoc` manual](rustdoc.html)
			* [The `rustpkg` manual](rustpkg.html)
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`# FAQs`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			`* [Language FAQ](complement-lang-faq.html)`
			`* [Project FAQ](complement-project-faq.html)`
			`* [Usage FAQ](complement-usage-faq.html)`
Move extra::flate to libflate This is hopefully the beginning of the long-awaited dissolution of libextra. Using the newly created build infrastructure for building libraries, I decided to move the first module out of libextra. While not being a particularly meaty module in and of itself, the flate module is required by rustc and additionally has a native C dependency. I was able to very easily split out the C dependency from rustrt, update librustc, and magically everything gets installed to the right locations and built automatically. This is meant to be a proof-of-concept commit to how easy it is to remove modules from libextra now. I didn't put any effort into modernizing the interface of libflate or updating it other than to remove the one glob import it had. 2014-01-24 23:00:31 -06:00			`* [Code cheatsheet](complement-cheatsheet.html) - "How do I do X?"`
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			`* [How to submit a bug report](complement-bugreport.html)`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
doc: Update style of index, organization and trim out some excess. 2014-01-06 19:24:19 -06:00			`# External resources`
First phase of migrating the wiki to the internal docs #11078 2013-12-22 20:21:45 -06:00
Move extra::flate to libflate This is hopefully the beginning of the long-awaited dissolution of libextra. Using the newly created build infrastructure for building libraries, I decided to move the first module out of libextra. While not being a particularly meaty module in and of itself, the flate module is required by rustc and additionally has a native C dependency. I was able to very easily split out the C dependency from rustrt, update librustc, and magically everything gets installed to the right locations and built automatically. This is meant to be a proof-of-concept commit to how easy it is to remove modules from libextra now. I didn't put any effort into modernizing the interface of libflate or updating it other than to remove the one glob import it had. 2014-01-24 23:00:31 -06:00			* The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - `#rust` on irc.mozilla.org
Update docs index to use lists Also include a missing link to the rustdoc manual 2014-01-15 19:19:36 -06:00			`* The Rust community on [Reddit](http://reddit.com/r/rust)`
			`* The Rust [wiki](http://github.com/mozilla/rust/wiki)`