mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6bacbcc32e
rust/src/doc/index.md

78 lines
3.3 KiB
Markdown
Raw Normal View History

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
doc: Add "A 30-minute Introduction to Rust" By Steve Klabnik.
2014-04-08 18:13:33 -05:00
* [A 30-minute Intro to Rust](intro.html) (read this first)
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)
docs: begin a "low-level & unsafe code" guide. This aims to cover the basics of writing safe unsafe code. At the moment it is just designed to be a better place for the `asm!()` docs than the detailed release notes wiki page, and I took the time to write up some other things. More examples are needed, especially of things that can subtly go wrong; and vast areas of `unsafe`-ty aren't covered, e.g. `static mut`s and thread-safety in general.
2014-03-14 10:13:48 -05:00
* [Writing Safe Unsafe and Low-Level Code](guide-unsafe.html)
Update docs index to use lists Also include a missing link to the rustdoc manual
2014-01-15 19:19:36 -06:00
* [Macros](guide-macros.html)
* [Testing](guide-testing.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
doc: Reorganize the library index Only single out std. Put everything else in a consistent list.
2014-02-16 02:21:08 -06:00
* [The standard library, `std`](std/index.html)
First phase of migrating the wiki to the internal docs #11078
2013-12-22 20:21:45 -06:00
docs: adjust code blocks to pass with rustdoc. The changes are basically just because rustdoc runs tests/rendering on more snippets by default (i.e. everything without a `notrust` tag), and not anything significant.
2014-03-08 05:05:20 -06:00
<!-- force the two lists to be separate -->
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)
moved collections from libextra into libcollections
2014-02-02 23:56:49 -06:00
* [The `collections` library](collections/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)
Added link to fourcc docs
2014-02-10 12:12:13 -06:00
* [The `fourcc` four-character code library](fourcc/index.html)
Move getopts out of extra
2014-02-02 17:20:32 -06:00
* [The `getopts` argument parsing library](getopts/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)
doc: Reorganize the library index Only single out std. Put everything else in a consistent list.
2014-02-16 02:21:08 -06:00
* [The `green` M:N runtime library](green/index.html)
docs: add two unlisted libraries to the index page.
2014-03-12 07:19:09 -05:00
* [The `hexfloat` library for hexadecimal floating-point literals](hexfloat/index.html)
Fix fallout from std::libc separation
2014-02-26 11:58:41 -06:00
* [The `libc` bindings](libc/index.html)
doc: Reorganize the library index Only single out std. Put everything else in a consistent list.
2014-02-16 02:21:08 -06:00
* [The `native` 1:1 threading runtime](native/index.html)
* [The `num` arbitrary precision numerics library](num/index.html)
docs: add two unlisted libraries to the index page.
2014-03-12 07:19:09 -05:00
* [The `rand` library for random numbers and distributions](rand/index.html)
doc: Reorganize the library index Only single out std. Put everything else in a consistent list.
2014-02-16 02:21:08 -06:00
* [The `rustc` compiler](rustc/index.html)
* [The `rustuv` M:N I/O library](rustuv/index.html)
Move semver out of libextra. Done as a part of #8784. Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-02-03 02:13:08 -06:00
* [The `semver` version collation library](semver/index.html)
pull extra::{serialize, ebml} into a separate libserialize crate - `extra::json` didn't make the cut, because of `extra::json` required dep on `extra::TreeMap`. If/when `extra::TreeMap` moves out of `extra`, then `extra::json` could move into `serialize` - `libextra`, `libsyntax` and `librustc` depend on the newly created `libserialize` - The extensions to various `extra` types like `DList`, `RingBuf`, `TreeMap` and `TreeSet` for `Encodable`/`Decodable` were moved into the respective modules in `extra` - There is some trickery, evident in `src/libextra/lib.rs` where a stub of `extra::serialize` is set up (in `src/libextra/serialize.rs`) for use in the stage0 build, where the snapshot rustc is still making deriving for `Encodable` and `Decodable` point at extra. Big props to @huonw for help working out the re-export solution for this extra: inline extra::serialize stub fix stuff clobbered in rebase + don't reexport serialize::serialize no more globs in libserialize syntax: fix import of libserialize traits librustc: fix bad imports in encoder/decoder add serialize dep to librustdoc fix failing run-pass tests w/ serialize dep adjust uuid dep more rebase de-clobbering for libserialize fixing tests, pushing libextra dep into cfg(test) fix doc code in extra::json adjust index.md links to serialize and uuid library
2014-02-05 10:52:54 -06:00
* [The `serialize` value encoding/decoding library](serialize/index.html)
move concurrent stuff from libextra to libsync
2014-01-30 14:04:47 -06:00
* [The `sync` library for concurrency-enabled mechanisms and primitives](sync/index.html)
doc: Reorganize the library index Only single out std. Put everything else in a consistent list.
2014-02-16 02:21:08 -06:00
* [The `syntax` library, the Rust parser](syntax/index.html)
pull extra::{serialize, ebml} into a separate libserialize crate - `extra::json` didn't make the cut, because of `extra::json` required dep on `extra::TreeMap`. If/when `extra::TreeMap` moves out of `extra`, then `extra::json` could move into `serialize` - `libextra`, `libsyntax` and `librustc` depend on the newly created `libserialize` - The extensions to various `extra` types like `DList`, `RingBuf`, `TreeMap` and `TreeSet` for `Encodable`/`Decodable` were moved into the respective modules in `extra` - There is some trickery, evident in `src/libextra/lib.rs` where a stub of `extra::serialize` is set up (in `src/libextra/serialize.rs`) for use in the stage0 build, where the snapshot rustc is still making deriving for `Encodable` and `Decodable` point at extra. Big props to @huonw for help working out the re-export solution for this extra: inline extra::serialize stub fix stuff clobbered in rebase + don't reexport serialize::serialize no more globs in libserialize syntax: fix import of libserialize traits librustc: fix bad imports in encoder/decoder add serialize dep to librustdoc fix failing run-pass tests w/ serialize dep adjust uuid dep more rebase de-clobbering for libserialize fixing tests, pushing libextra dep into cfg(test) fix doc code in extra::json adjust index.md links to serialize and uuid library
2014-02-05 10:52:54 -06:00
* [The `term` terminal-handling library](term/index.html)
Add `time` crate to index, expand docs of `test`.
2014-02-28 06:25:44 -06:00
* [The `test` library containing the unit-testing & micro-benchmark framework](test/index.html)
* [The `time` library](time/index.html)
pull extra::{serialize, ebml} into a separate libserialize crate - `extra::json` didn't make the cut, because of `extra::json` required dep on `extra::TreeMap`. If/when `extra::TreeMap` moves out of `extra`, then `extra::json` could move into `serialize` - `libextra`, `libsyntax` and `librustc` depend on the newly created `libserialize` - The extensions to various `extra` types like `DList`, `RingBuf`, `TreeMap` and `TreeSet` for `Encodable`/`Decodable` were moved into the respective modules in `extra` - There is some trickery, evident in `src/libextra/lib.rs` where a stub of `extra::serialize` is set up (in `src/libextra/serialize.rs`) for use in the stage0 build, where the snapshot rustc is still making deriving for `Encodable` and `Decodable` point at extra. Big props to @huonw for help working out the re-export solution for this extra: inline extra::serialize stub fix stuff clobbered in rebase + don't reexport serialize::serialize no more globs in libserialize syntax: fix import of libserialize traits librustc: fix bad imports in encoder/decoder add serialize dep to librustdoc fix failing run-pass tests w/ serialize dep adjust uuid dep more rebase de-clobbering for libserialize fixing tests, pushing libextra dep into cfg(test) fix doc code in extra::json adjust index.md links to serialize and uuid library
2014-02-05 10:52:54 -06:00
* [The `uuid` 128-bit universally unique identifier library](uuid/index.html)
extra: Put the nail in the coffin, delete libextra This commit shreds all remnants of libextra from the compiler and standard distribution. Two modules, c_vec/tempfile, were moved into libstd after some cleanup, and the other modules were moved to separate crates as seen fit. Closes #8784 Closes #12413 Closes #12576
2014-03-14 13:16:10 -05:00
* [The `url` library](url/index.html)
* [The `workcache` library](workcache/index.html)
Test fixes and rebase conflicts This commit switches over the backtrace infrastructure from piggy-backing off the RUST_LOG environment variable to using the RUST_BACKTRACE environment variable (logging is now disabled in libstd).
2014-03-13 01:34:31 -05:00
* [The `log` library](log/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)
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)
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
Mention more IRC channels on the documentation homepage This adds links to `#rust-gamedev`, `#rust-internals`, and `#rust-osdev`.
2014-04-05 14:57:31 -05:00
* The Rust IRC channels on [irc.mozilla.org](http://irc.mozilla.org/)
* [`#rust`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - general discussion
* [`#rust-gamedev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev) - game development
* [`#rust-internals`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals) - compiler and libraries
* [`#rust-osdev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev) - operating system development
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)
Reference in New Issue Copy Permalink