summaryrefslogtreecommitdiffstats
path: root/Help/prop_dir/RULE_LAUNCH_COMPILE.rst
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2022-06-02 12:18:17 (GMT)
committerCraig Scott <craig.scott@crascit.com>2022-06-02 12:18:17 (GMT)
commite281ba27b7a4d015b08f23d58ab45884c74452eb (patch)
tree6dbf5d2f2a5ce6f9863ca35a8ff90c7c614ca9a3 /Help/prop_dir/RULE_LAUNCH_COMPILE.rst
parentfa561c6d96e77654a12767a86ef7278cec1eff24 (diff)
downloadCMake-e281ba27b7a4d015b08f23d58ab45884c74452eb.zip
CMake-e281ba27b7a4d015b08f23d58ab45884c74452eb.tar.gz
CMake-e281ba27b7a4d015b08f23d58ab45884c74452eb.tar.bz2
Help: Clarify that RULE_LAUNCH_COMPILE is meant for internal use
Fixes: #22405
Diffstat (limited to 'Help/prop_dir/RULE_LAUNCH_COMPILE.rst')
-rw-r--r--Help/prop_dir/RULE_LAUNCH_COMPILE.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/Help/prop_dir/RULE_LAUNCH_COMPILE.rst b/Help/prop_dir/RULE_LAUNCH_COMPILE.rst
index 342d0ae..d9b550e 100644
--- a/Help/prop_dir/RULE_LAUNCH_COMPILE.rst
+++ b/Help/prop_dir/RULE_LAUNCH_COMPILE.rst
@@ -3,5 +3,11 @@ RULE_LAUNCH_COMPILE
Specify a launcher for compile rules.
-See the global property of the same name for details. This overrides
-the global property for a directory.
+.. note::
+ This property is intended for internal use by :manual:`ctest(1)`. Projects
+ and developers should use the :prop_tgt:`<LANG>_COMPILER_LAUNCHER` target
+ properties or the associated :variable:`CMAKE_<LANG>_COMPILER_LAUNCHER`
+ variables instead.
+
+See the :prop_gbl:`global property <RULE_LAUNCH_COMPILE>` of the same name
+for details. This overrides the global property for a directory.