summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJulien Schueller <schueller@phimeca.com>2018-09-14 07:19:27 (GMT)
committerJulien Schueller <schueller@phimeca.com>2018-09-17 08:05:30 (GMT)
commit17e581af4c950d26310b4665a051cf68bc0f7269 (patch)
tree83a8e4fa547f9169384ff75333f6d78aa9602a51
parentf0c84346ed25f6b8ce3a9f79aece87a58c8a4748 (diff)
downloadCMake-17e581af4c950d26310b4665a051cf68bc0f7269.zip
CMake-17e581af4c950d26310b4665a051cf68bc0f7269.tar.gz
CMake-17e581af4c950d26310b4665a051cf68bc0f7269.tar.bz2
Help: Document CMAKE_RULE_MESSAGES variable
Fixes: #18368
-rw-r--r--Help/manual/cmake-variables.7.rst1
-rw-r--r--Help/prop_gbl/RULE_MESSAGES.rst2
-rw-r--r--Help/variable/CMAKE_RULE_MESSAGES.rst8
3 files changed, 10 insertions, 1 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index d8a5def..6071999 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -78,6 +78,7 @@ Variables that Provide Information
/variable/CMAKE_PROJECT_VERSION_TWEAK
/variable/CMAKE_RANLIB
/variable/CMAKE_ROOT
+ /variable/CMAKE_RULE_MESSAGES
/variable/CMAKE_SCRIPT_MODE_FILE
/variable/CMAKE_SHARED_LIBRARY_PREFIX
/variable/CMAKE_SHARED_LIBRARY_SUFFIX
diff --git a/Help/prop_gbl/RULE_MESSAGES.rst b/Help/prop_gbl/RULE_MESSAGES.rst
index 87a5ca6..a9734a7 100644
--- a/Help/prop_gbl/RULE_MESSAGES.rst
+++ b/Help/prop_gbl/RULE_MESSAGES.rst
@@ -8,6 +8,6 @@ progress message describing what each build rule does. If the
property is not set the default is ON. Set the property to OFF to
disable granular messages and report only as each target completes.
This is intended to allow scripted builds to avoid the build time cost
-of detailed reports. If a ``CMAKE_RULE_MESSAGES`` cache entry exists
+of detailed reports. If a :variable:`CMAKE_RULE_MESSAGES` cache entry exists
its value initializes the value of this property. Non-Makefile
generators currently ignore this property.
diff --git a/Help/variable/CMAKE_RULE_MESSAGES.rst b/Help/variable/CMAKE_RULE_MESSAGES.rst
new file mode 100644
index 0000000..7460a81
--- /dev/null
+++ b/Help/variable/CMAKE_RULE_MESSAGES.rst
@@ -0,0 +1,8 @@
+CMAKE_RULE_MESSAGES
+-------------------
+
+Specify whether to report a message for each make rule.
+
+If set in the cache it is used to initialize the value of the :prop_gbl:`RULE_MESSAGES` property.
+Users may disable the option in their local build tree to disable granular messages
+and report only as each target completes in Makefile builds.