diff options
| author | Megan Wachs | 2021-03-18 16:47:58 -0700 |
|---|---|---|
| committer | GitHub | 2021-03-18 16:47:58 -0700 |
| commit | f1ad5b58e8a749d558758288d03ce75bf6b8ff9c (patch) | |
| tree | 2150d6f41a55f81c9f4cf3b037b715cb75ea617f /docs/src/wiki-deprecated/test-coverage.md | |
| parent | 2a56c6540e914611ac12647e157aec4c5c595758 (diff) | |
Reorganize website docs (#1806)
Updates to chisel3 documentation for website:
* guard code examples with mdoc and fix errors encountered along the way
* move some website content here vs splitting the content across two repos
* Bring in the interval-types and loading memories content so that it will be visible from the website
* remove all references to the wiki (deprecated)
* Remove reference to Wiki from the README
* fix tabbing and compile of chisel3-vs-chisel2 section
* Appendix: faqs now guarded and compile
* FAQs: move to resources section
Diffstat (limited to 'docs/src/wiki-deprecated/test-coverage.md')
| -rw-r--r-- | docs/src/wiki-deprecated/test-coverage.md | 21 |
1 files changed, 0 insertions, 21 deletions
diff --git a/docs/src/wiki-deprecated/test-coverage.md b/docs/src/wiki-deprecated/test-coverage.md deleted file mode 100644 index a3a622a2..00000000 --- a/docs/src/wiki-deprecated/test-coverage.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: docs -title: "Test Coverage" -section: "chisel3" ---- - -## Test Coverage Setup - -Chisel's sbt build instructions contain the requisite plug-in (sbt-scoverage) for generating test coverage information. Please see the [sbt-scoverage web page](https://github.com/scoverage/sbt-scoverage) for details on the plug-in. -The tests themselves are found in `src/test/scala`. - -## Generating A Test Coverage Report - -Use the following sequence of sbt commands to generate a test coverage report: -``` -sbt clean coverage test -sbt coverageReport -``` -The coverage reports should be found in `target/scala-x.yy/scoverage-report/{scoverage.xml,index.html}` where `x.yy` corresponds to the version of Scala used to compile Firrtl and the tests. -`scoverage.xml` is useful if you want to analyze the results programmatically. -`index.html` is designed for navigation with a web browser, allowing one to drill down to invidual statements covered (or not) by the tests. |