Add more comment

llvm-svn: 311025

1 files changed, 9 insertions, 1 deletions

diff --git a/llvm/lib/Bitcode/Writer/BitcodeWriter.cpp b/llvm/lib/Bitcode/Writer/BitcodeWriter.cpp
index e3b43b333a1..c81e2006ad8 100644
--- a/llvm/lib/Bitcode/Writer/BitcodeWriter.cpp
+++ b/llvm/lib/Bitcode/Writer/BitcodeWriter.cpp
@@ -3627,7 +3627,15 @@ void IndexBitcodeWriter::writeCombinedGlobalValueSummary() {
         if (!CallValueId)
           continue;
         // The mapping from OriginalId to GUID may return a GUID
-        // that corresponds to a static varible. Filter it out here.
+        // that corresponds to a static variable. Filter it out here.
+        // This can happen when 
+        // 1) There is a call to a library function which does not have
+        // a CallValidId;
+        // 2) There is a static variable with the  OriginalGUID identical
+        // to the GUID of the library function in 1);
+        // When this happens, the logic for SamplePGO kicks in and
+        // the static varible in 2) will be found, which needs to be
+        // filtered out.
         auto *GVSum = Index.getGlobalValueSummary(GUID, false);
         if (GVSum &&
             GVSum->getSummaryKind() == GlobalValueSummary::GlobalVarKind)