From a75ebe3ea48c957e3e7b8c1438ceb6136595eb61 Mon Sep 17 00:00:00 2001
From: Brad King <brad.king@kitware.com>
Date: Thu, 24 Mar 2011 09:24:27 -0400
Subject: [PATCH] Refine unused cache variable warning

List all unused variables in one warning.  Cleanup implementation to run
the check exactly once at the end of generation.
---
 Source/cmGlobalGenerator.cxx |  2 --
 Source/cmake.cxx             | 40 ++++++++++++++++++------------------
 Source/cmake.h               |  4 ++--
 Tests/CMakeLists.txt         |  2 +-
 4 files changed, 23 insertions(+), 25 deletions(-)

diff --git a/Source/cmGlobalGenerator.cxx b/Source/cmGlobalGenerator.cxx
index d47fb6f37..6c8938e5d 100644
--- a/Source/cmGlobalGenerator.cxx
+++ b/Source/cmGlobalGenerator.cxx
@@ -903,8 +903,6 @@ void cmGlobalGenerator::Generate()
     }
 
   this->CMakeInstance->UpdateProgress("Generating done", -1);
-
-  this->CMakeInstance->RunCheckForUnusedVariables("generation");
 }
 
 //----------------------------------------------------------------------------
diff --git a/Source/cmake.cxx b/Source/cmake.cxx
index bab0aaf83..221a2f3ba 100644
--- a/Source/cmake.cxx
+++ b/Source/cmake.cxx
@@ -2310,11 +2310,6 @@ int cmake::Run(const std::vector<std::string>& args, bool noconfigure)
   std::string oldstartoutputdir = this->GetStartOutputDirectory();
   this->SetStartDirectory(this->GetHomeDirectory());
   this->SetStartOutputDirectory(this->GetHomeOutputDirectory());
-  const bool warncli = this->WarnUnusedCli;
-  if (!this->ScriptMode)
-    {
-    this->WarnUnusedCli = false;
-    }
   int ret = this->Configure();
   if (ret || this->ScriptMode)
     {
@@ -2336,7 +2331,6 @@ int cmake::Run(const std::vector<std::string>& args, bool noconfigure)
 #endif
     return ret;
     }
-  this->WarnUnusedCli = warncli;
   ret = this->Generate();
   std::string message = "Build files have been written to: ";
   message += this->GetHomeOutputDirectory();
@@ -2358,6 +2352,10 @@ int cmake::Generate()
     return -1;
     }
   this->GlobalGenerator->Generate();
+  if(this->WarnUnusedCli)
+    {
+    this->RunCheckForUnusedVariables();
+    }
   if(cmSystemTools::GetErrorOccuredFlag())
     {
     return -1;
@@ -4320,23 +4318,25 @@ void cmake::UnwatchUnusedCli(const char* var)
 #endif
 }
 
-void cmake::RunCheckForUnusedVariables(const std::string& reason) const
+void cmake::RunCheckForUnusedVariables()
 {
 #ifdef CMAKE_BUILD_WITH_CMAKE
-    if(this->WarnUnusedCli)
+  bool haveUnused = false;
+  cmOStringStream msg;
+  msg << "Manually-specified variables were not used by the project:";
+  for(std::map<cmStdString, bool>::const_iterator
+        it = this->UsedCliVariables.begin();
+      it != this->UsedCliVariables.end(); ++it)
+    {
+    if(!it->second)
       {
-      std::map<std::string, bool>::const_iterator it;
-      for(it = this->UsedCliVariables.begin();
-          it != this->UsedCliVariables.end(); ++it)
-        {
-        if(!it->second)
-          {
-          std::string message = "CMake Warning: The variable, '" + it->first +
-            "', specified manually, was not used during the " + reason +
-            ".";
-          cmSystemTools::Message(message.c_str());
-          }
-        }
+      haveUnused = true;
+      msg << "\n  " << it->first;
       }
+    }
+  if(haveUnused)
+    {
+    this->IssueMessage(cmake::WARNING, msg.str(), cmListFileBacktrace());
+    }
 #endif
 }
diff --git a/Source/cmake.h b/Source/cmake.h
index 1bb42d32c..00fba57f8 100644
--- a/Source/cmake.h
+++ b/Source/cmake.h
@@ -368,8 +368,8 @@ class cmake
 
   void UnwatchUnusedCli(const char* var);
   void WatchUnusedCli(const char* var);
-  void RunCheckForUnusedVariables(const std::string& reason) const;
 protected:
+  void RunCheckForUnusedVariables();
   void InitializeProperties();
   int HandleDeleteCacheVariables(const char* var);
   cmPropertyMap Properties;
@@ -465,7 +465,7 @@ private:
   bool WarnUnused;
   bool WarnUnusedCli;
   bool CheckSystemVars;
-  std::map<std::string, bool> UsedCliVariables;
+  std::map<cmStdString, bool> UsedCliVariables;
   std::string CMakeEditCommand;
   std::string CMakeCommand;
   std::string CXXEnvironment;
diff --git a/Tests/CMakeLists.txt b/Tests/CMakeLists.txt
index 2c1191946..9fdc9f9f5 100644
--- a/Tests/CMakeLists.txt
+++ b/Tests/CMakeLists.txt
@@ -1202,7 +1202,7 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=master -P ${CMake_SOURCE_DIR}/Utilities/
     --build-project WarnUnusedCliUnused
     --build-options "-DUNUSED_CLI_VARIABLE=Unused")
   SET_TESTS_PROPERTIES(WarnUnusedCliUnused PROPERTIES
-    PASS_REGULAR_EXPRESSION "CMake Warning: The variable, 'UNUSED_CLI_VARIABLE'")
+    PASS_REGULAR_EXPRESSION "CMake Warning:.*Manually-specified variables were not used by the project:.*  UNUSED_CLI_VARIABLE")
   LIST(APPEND TEST_BUILD_DIRS "${CMake_BINARY_DIR}/Tests/WarnUnusedCliUnused")
 
   ADD_TEST(WarnUnusedCliUsed ${CMAKE_CTEST_COMMAND}