Skip to content
Latest commit d3ae56d Jun 25, 2016 @jseyfried jseyfried Rollup merge of #34403 - jonathandturner:move_liberror, r=alexcrichton
This PR refactors the 'errors' part of libsyntax into its own crate (librustc_errors).  This is the first part of a few refactorings to simplify error reporting and potentially support more output formats (like a standardized JSON output and possibly an --explain mode that can work with the user's code), though this PR stands on its own and doesn't assume further changes.

As part of separating out the errors crate, I have also refactored the code position portion of codemap into its own crate (libsyntax_pos).  While it's helpful to have the common code positions in a separate crate for the new errors crate, this may also enable further simplifications in the future.
..
Failed to load latest commit information.
book Rollup merge of #34403 - jonathandturner:move_liberror, r=alexcrichton Jun 25, 2016
nomicon Auto merge of #33895 - AndrewBrinker:master, r=steveklabnik Jun 9, 2016
style update features RFC Apr 28, 2016
README.md rustbuild: Run all markdown documentation tests Apr 19, 2016
complement-design-faq.md Remove the FAQs in favor of the website Dec 23, 2015
complement-lang-faq.md Remove the FAQs in favor of the website Dec 23, 2015
complement-project-faq.md Remove the FAQs in favor of the website Dec 23, 2015
favicon.inc Use https URLs to refer to rust-lang.org where appropriate. Aug 9, 2015
footer.inc Rollup merge of #33385 - cheercroaker:doc-correction, r=brson Jun 1, 2016
full-toc.inc doc: add webfonts and tweak the styles accordingly Apr 19, 2014
grammar.md Remove redundant semicolon from "block_expr" in grammar reference Feb 3, 2016
guide-crates.md Grammar tweak to old guide stub documents. Jan 16, 2015
guide-error-handling.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide-ffi.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide-macros.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide-ownership.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide-plugins.md doc: Fix a bunch of broken links Mar 8, 2016
guide-pointers.md Change removal notice for pointer guide. Jun 29, 2015
guide-strings.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide-tasks.md Fix broken link in old rust guide Mar 4, 2015
guide-testing.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide-unsafe.md Grammar tweak to old guide stub documents. Jan 17, 2015
guide.md Grammar tweak to old guide stub documents. Jan 17, 2015
index.md doc: Add descriptions to links in the index Jan 10, 2016
intro.md Remove the 30 minute intro Apr 18, 2015
not_found.md Use https URLs to refer to rust-lang.org where appropriate. Aug 9, 2015
reference.md reference: link to proper ffi attributes Jun 14, 2016
rust.css renamed last boolval to bool-val May 17, 2016
rust.md Update based on PR feedback Sep 30, 2014
rustc-ux-guidelines.md diagnostics comes from different places now Jun 20, 2016
rustdoc.md Move rustdoc.md into the book Jan 21, 2015
tutorial.md Re-direct to the right place. Jan 13, 2015
version_info.html.template Add alt tags for logos Jan 20, 2016

README.md

Rust documentations

Building

To generate all the docs, follow the "Building Documentation" instructions in the README in the root of the repository. This will convert the distributed Markdown docs to HTML and generate HTML doc for the books, '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:

rustdoc reference.md

(reference.md being the Rust Reference Manual.)

An overview of how to use the rustdoc command is available in the docs. Further details are available from the command line by with rustdoc --help.

Something went wrong with that request. Please try again.