From f1ad5b58e8a749d558758288d03ce75bf6b8ff9c Mon Sep 17 00:00:00 2001
From: Megan Wachs
Date: Thu, 18 Mar 2021 16:47:58 -0700
Subject: 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---
 docs/src/developers/test-coverage.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/src/developers/test-coverage.md

(limited to 'docs/src/developers/test-coverage.md')

diff --git a/docs/src/developers/test-coverage.md b/docs/src/developers/test-coverage.md
new file mode 100644
index 00000000..099db4bb
--- /dev/null
+++ b/docs/src/developers/test-coverage.md
@@ -0,0 +1,23 @@
+---
+layout: docs
+title:  "Test Coverage"
+section: "chisel3"
+---
+
+# Test Coverage
+
+## 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.
-- 
cgit v1.2.3