diff options
author | Vedant Kumar <vsk@apple.com> | 2017-02-09 21:33:21 +0000 |
---|---|---|
committer | Vedant Kumar <vsk@apple.com> | 2017-02-09 21:33:21 +0000 |
commit | 6eed0d5bb587d666de435e824ada09b6966dd15f (patch) | |
tree | 114958c8852c5d3f90cce1a4867f3aeedbc7a038 /clang/docs/SourceBasedCodeCoverage.rst | |
parent | 5bcb2d97f0cf5bf315387da61376d9df4deab823 (diff) | |
download | bcm5719-llvm-6eed0d5bb587d666de435e824ada09b6966dd15f.tar.gz bcm5719-llvm-6eed0d5bb587d666de435e824ada09b6966dd15f.zip |
[docs] coverage: Clarify which flags enable gcov-style profiling (NFC)
Point out that --coverage and -ftest-coverage, which is what most people
are used to, do not enable clang's frontend based coverage pass.
Suggested by Benn Bolay!
llvm-svn: 294626
Diffstat (limited to 'clang/docs/SourceBasedCodeCoverage.rst')
-rw-r--r-- | clang/docs/SourceBasedCodeCoverage.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst index 8e72b2287e9..474af30ae30 100644 --- a/clang/docs/SourceBasedCodeCoverage.rst +++ b/clang/docs/SourceBasedCodeCoverage.rst @@ -18,6 +18,7 @@ Clang ships two other code coverage implementations: various sanitizers. It can provide up to edge-level coverage. * gcov - A GCC-compatible coverage implementation which operates on DebugInfo. + This is enabled by ``-ftest-coverage`` or ``--coverage``. From this point onwards "code coverage" will refer to the source-based kind. |