Browse Source

Help: Clarify that RULE_LAUNCH_COMPILE is meant for internal use

Fixes: #22405
Craig Scott 3 years ago
parent
commit
e281ba27b7

+ 8 - 2
Help/prop_dir/RULE_LAUNCH_COMPILE.rst

@@ -3,5 +3,11 @@ RULE_LAUNCH_COMPILE
 
 
 Specify a launcher for compile rules.
 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.

+ 8 - 2
Help/prop_dir/RULE_LAUNCH_LINK.rst

@@ -3,5 +3,11 @@ RULE_LAUNCH_LINK
 
 
 Specify a launcher for link rules.
 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.

+ 6 - 0
Help/prop_gbl/RULE_LAUNCH_COMPILE.rst

@@ -3,6 +3,12 @@ RULE_LAUNCH_COMPILE
 
 
 Specify a launcher for compile rules.
 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
 :ref:`Makefile Generators` and the :generator:`Ninja` generator prefix
 compiler commands with the given launcher command line.
 compiler commands with the given launcher command line.
 This is intended to allow launchers to intercept build problems
 This is intended to allow launchers to intercept build problems

+ 6 - 0
Help/prop_gbl/RULE_LAUNCH_LINK.rst

@@ -3,6 +3,12 @@ RULE_LAUNCH_LINK
 
 
 Specify a launcher for link rules.
 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
 :ref:`Makefile Generators` and the :generator:`Ninja` generator prefix
 link and archive commands with the given launcher command line.
 link and archive commands with the given launcher command line.
 This is intended to allow launchers to intercept build problems
 This is intended to allow launchers to intercept build problems

+ 8 - 2
Help/prop_tgt/RULE_LAUNCH_COMPILE.rst

@@ -3,5 +3,11 @@ RULE_LAUNCH_COMPILE
 
 
 Specify a launcher for compile rules.
 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.

+ 8 - 2
Help/prop_tgt/RULE_LAUNCH_LINK.rst

@@ -3,5 +3,11 @@ RULE_LAUNCH_LINK
 
 
 Specify a launcher for link rules.
 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.