4d52d7c857
I've been baking this out of tree for long enough. This is currently about ~2/5ths the size of TRPL. Time to get it in tree so it can be more widely maintained and scrutinized. I've preserved the whole gruesome history including various rewrites. I can definitely squash these a fair amount if desired. Some random people submitted minor fixes though, so they're mixed in. Edit: forgot to link to rendered http://cglab.ca/~abeinges/blah/turpl/_book/ Edit2: To streamline the review process, I'm going to break this into sections that need official "domain expert" approval: # Summary * [ ] references.md -- very important, needs work * [x] Meet Safe and Unsafe: reviewed by @aturon * [x] Data Layout: reviewed by @arielb1 * [x] Ownership: reviewed by @aturon ( and sorta @nikomatsakis ) -- significantly updated, may need re-r * [x] Coversions: reviewed by @nrc * [x] Uninitialized Memory: reviewed by @pnkfelix * [x] Ownership-Oriented Resource Management: reviewed by @aturon * [x] Unwinding: reviewed by @alexcrichton * [x] Concurrency: reviewed by @aturon * [x] Implementing Vec: r? @huonw
Rust documentations
Dependencies
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.
Building
To generate all the docs, just run make docs from the root of the repository.
This will convert the distributed Markdown docs to HTML and generate HTML doc
for the 'std' and 'extra' libraries.
To generate HTML documentation from one source file/crate, do something like:
rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
(This, of course, requires a working build of the rustdoc tool.)
Additional notes
To generate an HTML version of a doc from Markdown manually, you can do something like:
pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
(reference.md being the Rust Reference Manual.)
The syntax for pandoc flavored markdown can be found at:
A nice quick reference (for non-pandoc markdown) is at: