From: Vedant Kumar <vsk@apple.com>
Date: Mon, 19 Sep 2016 02:15:59 +0000 (+0000)
Subject: [llvm-cov] Emit a link to some documentation
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=764028eefaf9d2b89e0ff25a4e73b150f2472b43;p=llvm

[llvm-cov] Emit a link to some documentation

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

diff --git a/tools/llvm-cov/SourceCoverageViewHTML.cpp b/tools/llvm-cov/SourceCoverageViewHTML.cpp
index cb9760ad7c9..5a984cf2eb9 100644
--- a/tools/llvm-cov/SourceCoverageViewHTML.cpp
+++ b/tools/llvm-cov/SourceCoverageViewHTML.cpp
@@ -374,6 +374,13 @@ Error CoveragePrinterHTML::createIndexFile(
   if (Opts.hasCreatedTime())
     OSRef << tag(CreatedTimeTag, escape(Opts.CreatedTimeStr, Opts));
 
+  // Emit a link to some documentation.
+  OSRef << tag("p", "Click " +
+                        a("http://clang.llvm.org/docs/"
+                          "SourceBasedCodeCoverage.html#interpreting-reports",
+                          "here") +
+                        " for information about interpreting this report.");
+
   // Emit a table containing links to reports for each file in the covmapping.
   OSRef << BeginCenteredDiv << BeginTable;
   emitColumnLabelsForIndex(OSRef);