summaryrefslogtreecommitdiffstats
path: root/docs/code_coverage.md
diff options
context:
space:
mode:
authorandybons <andybons@chromium.org>2015-08-24 14:37:09 -0700
committerCommit bot <commit-bot@chromium.org>2015-08-24 21:39:36 +0000
commit3322f7611ba1444e553b2cce4de3a1a32ad46e72 (patch)
treedfb6bbea413da0581b8d085b184a5e6ceea5af3e /docs/code_coverage.md
parent5d58c9eb2baa203be1b84ac88cde82c59d72f143 (diff)
downloadchromium_src-3322f7611ba1444e553b2cce4de3a1a32ad46e72.zip
chromium_src-3322f7611ba1444e553b2cce4de3a1a32ad46e72.tar.gz
chromium_src-3322f7611ba1444e553b2cce4de3a1a32ad46e72.tar.bz2
Per https://groups.google.com/a/chromium.org/forum/#!topic/chromium-dev/irLAQ8f8uGk
Initial migration of wiki content over to src/docs There will be a follow-up CL to ensure docs are following chromium’s style guide, links are fixed, etc. The file auditing was becoming too much for a single change and per Nico’s suggestion, it seems to be better to do + Bulk import with initial prune. + Follow-up CLs to clean up the documentation. So that each CL has its own purpose. BUG=none Review URL: https://codereview.chromium.org/1309473002 Cr-Commit-Position: refs/heads/master@{#345186}
Diffstat (limited to 'docs/code_coverage.md')
-rw-r--r--docs/code_coverage.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/code_coverage.md b/docs/code_coverage.md
new file mode 100644
index 0000000..3cfd3c0
--- /dev/null
+++ b/docs/code_coverage.md
@@ -0,0 +1,28 @@
+# Categories of coverage
+
+ * <strong><font color='greeb'>executed</font></strong> - this line of code was hit during execution
+ * <strong><font color='orange'>instrumented</font></strong> - this line of code was part of the compilation unit, but not executed
+ * <strong><font color='red'>missing</font></strong> - 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. \ No newline at end of file