ENH: Allow projects to disable per-rule progress

This creates global property RULE_PROGRESS which can be set to disbale
per-rule progress reporting.  On Windows, progress reports may cause a
noticable delay due to the cost of starting an extra process.  This
feature will allow scripted builds to avoid the cost since they do not
need detailed progress anyway.  See issue #8726.

Modules/CMakeGenericSystem.cmake

@@ -33,6 +33,9 @@ IF(CMAKE_GENERATOR MATCHES "Makefiles")
     "Enable/Disable color output during build."
     )
   MARK_AS_ADVANCED(CMAKE_COLOR_MAKEFILE)
+  IF(DEFINED CMAKE_RULE_PROGRESS)
+    SET_PROPERTY(GLOBAL PROPERTY RULE_PROGRESS ${CMAKE_RULE_PROGRESS})
+  ENDIF(DEFINED CMAKE_RULE_PROGRESS)
 ENDIF(CMAKE_GENERATOR MATCHES "Makefiles")
 
 # Set a variable to indicate whether the value of CMAKE_INSTALL_PREFIX

Source/cmMakefileTargetGenerator.cxx

@@ -46,6 +46,12 @@ cmMakefileTargetGenerator::cmMakefileTargetGenerator(cmTarget* target)
   this->GlobalGenerator =
     static_cast<cmGlobalUnixMakefileGenerator3*>(
       this->LocalGenerator->GetGlobalGenerator());
+  cmake* cm = this->GlobalGenerator->GetCMakeInstance();
+  this->NoRuleProgress = false;
+  if(const char* ruleProgress = cm->GetProperty("RULE_PROGRESS"))
+    {
+    this->NoRuleProgress = cmSystemTools::IsOff(ruleProgress);
+    }
 }
 
 cmMakefileTargetGenerator *
@@ -196,6 +202,8 @@ void cmMakefileTargetGenerator::WriteCommonCodeRules()
                      cmLocalGenerator::MAKEFILE)
     << "\n\n";
 
+  if(!this->NoRuleProgress)
+    {
     // Include the progress variables for the target.
     *this->BuildFileStream
       << "# Include the progress variables for this target.\n"
@@ -204,6 +212,7 @@ void cmMakefileTargetGenerator::WriteCommonCodeRules()
                        cmLocalGenerator::HOME_OUTPUT,
                        cmLocalGenerator::MAKEFILE)
       << "\n\n";
+    }
 
   // make sure the depend file exists
   if (!cmSystemTools::FileExists(dependFileNameFull.c_str()))
@@ -1200,6 +1209,10 @@ void
 cmMakefileTargetGenerator::AppendProgress(std::vector<std::string>& commands)
 {
   this->NumberOfProgressActions++;
+  if(this->NoRuleProgress)
+    {
+    return;
+    }
   std::string progressDir = this->Makefile->GetHomeOutputDirectory();
   progressDir += cmake::GetCMakeFilesDirectory();
   cmOStringStream progCmd;

Source/cmMakefileTargetGenerator.h

@@ -170,6 +170,7 @@ protected:
   std::string ProgressFileName;
   std::string ProgressFileNameFull;
   unsigned long NumberOfProgressActions;
+  bool NoRuleProgress;
 
   // the path to the directory the build file is in
   std::string TargetBuildDirectory;

Source/cmake.cxx

@@ -3454,6 +3454,20 @@ void cmake::DefineProperties(cmake *cm)
      "with high granularity.  "
      "Non-Makefile generators currently ignore this property.");
 
+  cm->DefineProperty
+    ("RULE_PROGRESS", cmProperty::GLOBAL,
+     "Specify whether to report progress for each make rule.",
+     "Makefile generators add commands to report progress.  "
+     "This property specifies whether to report progress on every rule.  "
+     "If the property is not set the default is ON.  "
+     "Set the property to OFF to disable granular progress and report only "
+     "as each target completes.  "
+     "This is intended to allow scripted builds to avoid the build time "
+     "cost of detailed progress reports.  "
+     "If a CMAKE_RULE_PROGRESS cache entry exists its value initializes "
+     "the value of this property.  "
+     "Non-Makefile generators currently ignore this property.");
+
   // ================================================================
   // define variables as well
   // ================================================================

Tests/Complex/CMakeLists.txt

@@ -14,6 +14,9 @@ IF(POLICY CMP0003)
   ENDIF(NOT "${P3}" STREQUAL "NEW")
 ENDIF(POLICY CMP0003)
 
+# Test building without per-rule progress in Makefiles.
+SET_PROPERTY(GLOBAL PROPERTY RULE_PROGRESS OFF)
+
 # Choose whether to test CMakeLib.
 SET(COMPLEX_TEST_CMAKELIB 1)
 IF(CMAKE_TEST_DIFFERENT_GENERATOR)

Tests/ComplexOneConfig/CMakeLists.txt

@@ -14,6 +14,9 @@ IF(POLICY CMP0003)
   ENDIF(NOT "${P3}" STREQUAL "NEW")
 ENDIF(POLICY CMP0003)
 
+# Test building without per-rule progress in Makefiles.
+SET_PROPERTY(GLOBAL PROPERTY RULE_PROGRESS OFF)
+
 # Choose whether to test CMakeLib.
 SET(COMPLEX_TEST_CMAKELIB 1)
 IF(CMAKE_TEST_DIFFERENT_GENERATOR)

Tests/ComplexRelativePaths/CMakeLists.txt

@@ -14,6 +14,9 @@ IF(POLICY CMP0003)
   ENDIF(NOT "${P3}" STREQUAL "NEW")
 ENDIF(POLICY CMP0003)
 
+# Test building without per-rule progress in Makefiles.
+SET_PROPERTY(GLOBAL PROPERTY RULE_PROGRESS OFF)
+
 # Choose whether to test CMakeLib.
 SET(COMPLEX_TEST_CMAKELIB 1)
 IF(CMAKE_TEST_DIFFERENT_GENERATOR)