1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-15 12:16:40 +08:00

Help: Document try_run output cache entries for cross-build

Document `try_run` cache entries added by commit a2cd0687db (try_run:
Add RUN_OUTPUT_STDOUT_VARIABLE and RUN_OUTPUT_STDERR_VARIABLE.,
2022-07-08, v3.25.0-rc1~443^2):

* `<runResultVar>__TRYRUN_OUTPUT_STDOUT`
* `<runResultVar>__TRYRUN_OUTPUT_STDERR`

Fixes: #27281
This commit is contained in:
Jinzhe Zeng
2025-10-06 03:56:31 -04:00
committed by Brad King
parent ceecafd7d5
commit 6d61783103

View File

@@ -155,6 +155,20 @@ These cache entries are:
the target platform. This is created only if the
``RUN_OUTPUT_VARIABLE`` or ``OUTPUT_VARIABLE`` option was used.
``<runResultVar>__TRYRUN_OUTPUT_STDOUT``
.. versionadded:: 3.25
Output from stdout if the executable were to be run on the target
platform. This is created only if the ``RUN_OUTPUT_STDOUT_VARIABLE``
or ``RUN_OUTPUT_STDERR_VARIABLE`` option was used.
``<runResultVar>__TRYRUN_OUTPUT_STDERR``
.. versionadded:: 3.25
Output from stderr if the executable were to be run on the target
platform. This is created only if the ``RUN_OUTPUT_STDOUT_VARIABLE``
or ``RUN_OUTPUT_STDERR_VARIABLE`` option was used.
In order to make cross compiling your project easier, use ``try_run``
only if really required. If you use ``try_run``, use the
``RUN_OUTPUT_STDOUT_VARIABLE``, ``RUN_OUTPUT_STDERR_VARIABLE``,