r294626 - [docs] coverage: Clarify which flags enable gcov-style profiling (NFC)

[Vedant Kumar via cfe-commits]

Author: vedantk
Date: Thu Feb  9 15:33:21 2017
New Revision: 294626

URL: http://llvm.org/viewvc/llvm-project?rev=294626&view=rev
Log:
[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!

Modified:
    cfe/trunk/docs/SourceBasedCodeCoverage.rst

Modified: cfe/trunk/docs/SourceBasedCodeCoverage.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/SourceBasedCodeCoverage.rst?rev=294626&r1=294625&r2=294626&view=diff
==============================================================================
--- cfe/trunk/docs/SourceBasedCodeCoverage.rst (original)
+++ cfe/trunk/docs/SourceBasedCodeCoverage.rst Thu Feb  9 15:33:21 2017
@@ -18,6 +18,7 @@ Clang ships two other code coverage impl
   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.