[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!

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@294626 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/SourceBasedCodeCoverage.rst b/docs/SourceBasedCodeCoverage.rst
index 8e72b2287e9c52cec38559db82413f102f04817b..474af30ae30f7a1f7a1a868262f017fb0d4668c6 100644 (file)
--- a/docs/SourceBasedCodeCoverage.rst
+++ b/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.