From: Vedant Kumar <vsk@apple.com>
Date: Thu, 9 Feb 2017 21:33:21 +0000 (+0000)
Subject: [docs] coverage: Clarify which flags enable gcov-style profiling (NFC)
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bc505a9b466d7920da3db7989f1bf23509b23202;p=clang

[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 8e72b2287e..474af30ae3 100644
--- 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.