Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(239)

Unified Diff: docs/code_coverage.md

Issue 1309473002: WIP: Migrate Wiki content over to src/docs (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/cocoa_tips_and_tricks.md ('k') | docs/common_build_tasks.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/code_coverage.md
diff --git a/docs/code_coverage.md b/docs/code_coverage.md
new file mode 100644
index 0000000000000000000000000000000000000000..3cfd3c026389c5f56615556c18e9c8ef1f9eccb9
--- /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 previous file with comments | « docs/cocoa_tips_and_tricks.md ('k') | docs/common_build_tasks.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698