Merge topic 'doc-RULE_LAUNCH_COMPILE'

e281ba27b7 Help: Clarify that RULE_LAUNCH_COMPILE is meant for internal use

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7317

6 files changed, 44 insertions, 8 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.
diff --git a/Help/prop_dir/RULE_LAUNCH_LINK.rst b/Help/prop_dir/RULE_LAUNCH_LINK.rst
index 3cfb236..922c8d5 100644
--- a/Help/prop_dir/RULE_LAUNCH_LINK.rst
+++ b/Help/prop_dir/RULE_LAUNCH_LINK.rst
@@ -3,5 +3,11 @@ RULE_LAUNCH_LINK
 
 Specify a launcher for link 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>_LINKER_LAUNCHER` target
+  properties or the associated :variable:`CMAKE_<LANG>_LINKER_LAUNCHER`
+  variables instead.
+
+See the :prop_gbl:`global property <RULE_LAUNCH_LINK>` of the same name for
+details.  This overrides the global property for a directory.
diff --git a/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst b/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst
index e0df878..a43e9e5 100644
--- a/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst
+++ b/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst
@@ -3,6 +3,12 @@ RULE_LAUNCH_COMPILE
 
 Specify a launcher for compile rules.
 
+.. 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.
+
 :ref:`Makefile Generators` and the :generator:`Ninja` generator prefix
 compiler commands with the given launcher command line.
 This is intended to allow launchers to intercept build problems
diff --git a/Help/prop_gbl/RULE_LAUNCH_LINK.rst b/Help/prop_gbl/RULE_LAUNCH_LINK.rst
index 567bb68..da376fe 100644
--- a/Help/prop_gbl/RULE_LAUNCH_LINK.rst
+++ b/Help/prop_gbl/RULE_LAUNCH_LINK.rst
@@ -3,6 +3,12 @@ RULE_LAUNCH_LINK
 
 Specify a launcher for link rules.
 
+.. note::
+  This property is intended for internal use by :manual:`ctest(1)`.  Projects
+  and developers should use the :prop_tgt:`<LANG>_LINKER_LAUNCHER` target
+  properties or the associated :variable:`CMAKE_<LANG>_LINKER_LAUNCHER`
+  variables instead.
+
 :ref:`Makefile Generators` and the :generator:`Ninja` generator prefix
 link and archive commands with the given launcher command line.
 This is intended to allow launchers to intercept build problems
diff --git a/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst
index e92ab86..3f4305f 100644
--- a/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst
+++ b/Help/prop_tgt/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 and directory property for a target.
+.. 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 and directory property for a target.
diff --git a/Help/prop_tgt/RULE_LAUNCH_LINK.rst b/Help/prop_tgt/RULE_LAUNCH_LINK.rst
index f330033..da93be2 100644
--- a/Help/prop_tgt/RULE_LAUNCH_LINK.rst
+++ b/Help/prop_tgt/RULE_LAUNCH_LINK.rst
@@ -3,5 +3,11 @@ RULE_LAUNCH_LINK
 
 Specify a launcher for link rules.
 
-See the global property of the same name for details.  This overrides
-the global and directory property for a target.
+.. note::
+  This property is intended for internal use by :manual:`ctest(1)`.  Projects
+  and developers should use the :prop_tgt:`<LANG>_LINKER_LAUNCHER` target
+  properties or the associated :variable:`CMAKE_<LANG>_LINKER_LAUNCHER`
+  variables instead.
+
+See the :prop_gbl:`global property <RULE_LAUNCH_LINK>` of the same name for
+details.  This overrides the global and directory property for a target.