mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-23 23:34:48 +00:00
2fd3c07242
Many people will be very confused that their debug! statements aren't working when they first use rust only to learn that they should have been building with `--cfg debug` the entire time. This inverts the meaning of the flag to instead of enabling debug statements, now it disables debug statements. This way the default behavior is a bit more reasonable, and requires less end-user configuration. Furthermore, this turns on debug by default when building the rustc compiler. |
||
|---|---|---|
| .. | ||
| lib | ||
| po | ||
| lib.css | ||
| manual.css | ||
| po4a.conf | ||
| prep.js | ||
| README | ||
| rust.css | ||
| rust.md | ||
| rustpkg.md | ||
| tutorial-borrowed-ptr.md | ||
| tutorial-conditions.md | ||
| tutorial-container.md | ||
| tutorial-ffi.md | ||
| tutorial-macros.md | ||
| tutorial-rustpkg.md | ||
| tutorial-tasks.md | ||
| tutorial.md | ||
| version_info.html.template | ||
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code. It's available for most platforms here: http://johnmacfarlane.net/pandoc/installing.html Node.js (http://nodejs.org/) is also required for generating HTML from the Markdown docs (reference manual, tutorials, etc.) distributed with this git repository. To generate all the docs, 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-dir html-doc/ --output-format html ../src/libstd/path.rs (This, of course, requires that you've built/installed the `rustdoc` tool.) To generate an HTML version of a doc from Markdown, without having Node.js installed, do something like: pandoc --from=markdown --to=html --number-sections -o rust.html rust.md The syntax for pandoc flavored markdown can be found at: http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown A nice quick reference (for non-pandoc markdown) is at: http://kramdown.rubyforge.org/quickref.html