summaryrefslogtreecommitdiff
path: root/chromium/docs/code_coverage.md
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@theqtcompany.com>2015-10-13 13:24:50 +0200
committerAllan Sandfeld Jensen <allan.jensen@theqtcompany.com>2015-10-14 10:57:25 +0000
commitaf3d4809763ef308f08ced947a73b624729ac7ea (patch)
tree4402b911e30383f6c6dace1e8cf3b8e85355db3a /chromium/docs/code_coverage.md
parent0e8ff63a407fe323e215bb1a2c423c09a4747c8a (diff)
downloadqtwebengine-chromium-af3d4809763ef308f08ced947a73b624729ac7ea.tar.gz
BASELINE: Update Chromium to 47.0.2526.14
Also adding in sources needed for spellchecking. Change-Id: Idd44170fa1616f26315188970a8d5ba7d472b18a Reviewed-by: Michael BrĂ¼ning <michael.bruning@theqtcompany.com>
Diffstat (limited to 'chromium/docs/code_coverage.md')
-rw-r--r--chromium/docs/code_coverage.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/chromium/docs/code_coverage.md b/chromium/docs/code_coverage.md
new file mode 100644
index 00000000000..484cecc0e2c
--- /dev/null
+++ b/chromium/docs/code_coverage.md
@@ -0,0 +1,41 @@
+# Code Coverage
+
+## Categories of coverage
+
+* executed - this line of code was hit during execution
+* instrumented - this line of code was part of the compilation unit, but not
+ executed
+* missing - in a source file, but not compiled.
+* ignored - not an executable line, or a line we don't care about
+
+Coverage is calculated as `exe / (inst + miss)`. In general, lines that are in
+`miss` should be ignored, but our exclusion rules are not good enough.
+
+## Buildbots
+
+Buildbots are currently on the
+[experimental waterfall](http://build.chromium.org/buildbot/waterfall.fyi/waterfall).
+The coverage figures they calculate come from running some subset of the
+chromium testing suite.
+
+* [Linux](http://build.chromium.org/buildbot/waterfall.fyi/builders/Linux%20Coverage%20(dbg))
+ - uses `gcov`
+* [Windows](http://build.chromium.org/buildbot/waterfall.fyi/builders/Win%20Coverage%20%28dbg%29)
+* [Mac](http://build.chromium.org/buildbot/waterfall.fyi/builders/Mac%20Coverage%20%28dbg%29)
+
+Also,
+
+* [Coverage dashboard](http://build.chromium.org/buildbot/coverage/)
+* [Example coverage summary](http://build.chromium.org/buildbot/coverage/linux-debug/49936/)
+ - the coverage is calculated at directory and file level, and the directory
+ structure is navigable via the **Subdirectories** table.
+
+## Calculating coverage locally
+
+TODO
+
+## Advanced Tips
+
+Sometimes a line of code should never be reached (e.g., `NOTREACHED()`). These
+can be marked in the source with `// COV_NF_LINE`. Note that this syntax is
+exact.