summaryrefslogtreecommitdiffstats
path: root/docs/code_coverage.md
diff options
context:
space:
mode:
authorandybons <andybons@chromium.org>2015-08-26 13:12:52 -0700
committerCommit bot <commit-bot@chromium.org>2015-08-26 20:13:51 +0000
commit6eaa0c0d0154e824a99267abb24bd536b7bacae1 (patch)
treeea9fdb22795549c5beecd28d078cef47e477ef56 /docs/code_coverage.md
parent00d111c262fc3bc3b0354ef747bb714c109634fa (diff)
downloadchromium_src-6eaa0c0d0154e824a99267abb24bd536b7bacae1.zip
chromium_src-6eaa0c0d0154e824a99267abb24bd536b7bacae1.tar.gz
chromium_src-6eaa0c0d0154e824a99267abb24bd536b7bacae1.tar.bz2
Markdown style fixes for:
code_coverage.md cocoa_tips_and_tricks.md closure_compilation.md clang_format.md clang_tool_refactoring.md clang.md R=nodir BUG=524256 Review URL: https://codereview.chromium.org/1306233003 Cr-Commit-Position: refs/heads/master@{#345652}
Diffstat (limited to 'docs/code_coverage.md')
-rw-r--r--docs/code_coverage.md45
1 files changed, 29 insertions, 16 deletions
diff --git a/docs/code_coverage.md b/docs/code_coverage.md
index 3cfd3c0..484cecc 100644
--- a/docs/code_coverage.md
+++ b/docs/code_coverage.md
@@ -1,28 +1,41 @@
-# Categories of coverage
+# Code 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
+## Categories of coverage
-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.
+* 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
-# Buildbots
+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 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.
+## Buildbots
- * [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)
+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
+* [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
+## 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
+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.