diff options
| author | bors <bors@rust-lang.org> | 2013-12-23 09:16:37 -0800 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2013-12-23 09:16:37 -0800 |
| commit | d9c06586f2aa12f89c94a27a20f0d0b260da216e (patch) | |
| tree | e886da2ed2d5ca57025853fa1410149941ea179d /src/rustllvm/RustWrapper.cpp | |
| parent | f71c0dc2cd876f50252cdb907a6f05493c56d3cc (diff) | |
| parent | f9b231cd0884fe90a730d637517c257a4f0c601a (diff) | |
| download | rust-d9c06586f2aa12f89c94a27a20f0d0b260da216e.tar.gz rust-d9c06586f2aa12f89c94a27a20f0d0b260da216e.zip | |
auto merge of #11120 : alexcrichton/rust/rustdoc-test, r=brson
This commit adds a `--test` flag to rustdoc to expose the ability to test code examples in doc strings. This work by using sundown's `lang` attribute to figure out how a code block should be tested. The format for this is: ``` 1. ```rust 2. ```rust,ignore 3. ```rust,notest 4. ```rust,should_fail ``` Where `rust` means that rustdoc will attempt to test is, `ignore` means that it will not execute the test but it will compile it, `notest` means that rustdoc completely ignores it, and `should_fail` means that the test should fail. This commit also leverages `extra::test` for the testing harness in order to allow parallelization and whatnot. I have fixed all existing code examples in libstd and libextra, but I have not made a pass through the crates in order to change code blocks to testable code blocks. It may also be a questionable decision to require opting-in to a testable code block. Finally, I kept our sugar in the doc suite to omit lines starting with `#` in documentation but still process them during tests. Closes #2925
Diffstat (limited to 'src/rustllvm/RustWrapper.cpp')
0 files changed, 0 insertions, 0 deletions
