When -Z profile is passed, the GCDAProfiling LLVM pass is added to the pipeline, which uses debug information to instrument the IR. After compiling with -Z profile, the $(OUT_DIR)/$(CRATE_NAME).gcno file is created, containing initial profiling information. After running the program built, the $(OUT_DIR)/$(CRATE_NAME).gcda file is created, containing branch counters. The created *.gcno and *.gcda files can be processed using the "llvm-cov gcov" and "lcov" tools. The profiling data LLVM generates does not faithfully follow the GCC's format for *.gcno and *.gcda files, and so it will probably not work with other tools (such as gcov itself) that consume these files. |
||
---|---|---|
.. | ||
book@ad7de19856 | ||
nomicon@616b98444f | ||
reference@6b0de90d87 | ||
unstable-book | ||
README.md | ||
complement-design-faq.md | ||
complement-lang-faq.md | ||
complement-project-faq.md | ||
favicon.inc | ||
footer.inc | ||
full-toc.inc | ||
grammar.md | ||
guide-crates.md | ||
guide-error-handling.md | ||
guide-ffi.md | ||
guide-macros.md | ||
guide-ownership.md | ||
guide-plugins.md | ||
guide-pointers.md | ||
guide-strings.md | ||
guide-tasks.md | ||
guide-testing.md | ||
guide-unsafe.md | ||
guide.md | ||
index.md | ||
intro.md | ||
not_found.md | ||
reference.md | ||
rust.css | ||
rust.md | ||
rustc-ux-guidelines.md | ||
rustdoc.md | ||
tutorial.md | ||
version_info.html.template |
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
.