Help: Clarify that RULE_LAUNCH_COMPILE is meant for internal use

Fixes: #22405
This commit is contained in:
Craig Scott
2022-06-02 22:18:17 +10:00
parent fa561c6d96
commit e281ba27b7
6 changed files with 44 additions and 8 deletions

View File

@@ -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.

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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.

View File

@@ -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.