From: Vedant Kumar <vsk@apple.com>
Date: Mon, 19 Jun 2017 21:22:05 +0000 (+0000)
Subject: [docs] Coverage: document issue with the BFD linker
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ff84b9403504ae9eaefbc1eafe58da87dd590e39;p=clang

[docs] Coverage: document issue with the BFD linker

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

diff --git a/docs/SourceBasedCodeCoverage.rst b/docs/SourceBasedCodeCoverage.rst
index 474af30ae3..c38a00386d 100644
--- a/docs/SourceBasedCodeCoverage.rst
+++ b/docs/SourceBasedCodeCoverage.rst
@@ -274,6 +274,11 @@ To specify an alternate directory for raw profiles, use
 Drawbacks and limitations
 =========================
 
+* Prior to version 2.26, the GNU binutils BFD linker is not able link programs
+  with coverage enabled when the ``--gc-sections`` is enabled. The suggested
+  workaround is to either upgrade to a newer version of BFD, or to use the Gold
+  linker.
+
 * Code coverage does not handle unpredictable changes in control flow or stack
   unwinding in the presence of exceptions precisely. Consider the following
   function: