Help: Check*SourceRuns make text more concise.

Similar simplification was done in !9641 for Check*SourceCompiles
This commit is contained in:
Michael Hirsch
2024-08-15 22:24:12 -04:00
parent 5d42177a06
commit 759776dcdb
6 changed files with 50 additions and 83 deletions
+8 -12
View File
@@ -18,12 +18,14 @@ subsequently be run.
check_source_runs(<lang> <code> <resultVar>
[SRC_EXT <extension>])
Check that the source supplied in ``<code>`` can be compiled as a source
file for the requested language, linked as an executable and then run.
If the ``<code>`` could be built and run successfully, the internal cache variable
specified by ``<resultVar>`` will be set to 1, otherwise it will be set to
a value that evaluates to boolean false (e.g. an empty string or an error
message).
Check once that the ``<lang>`` source supplied in ``<code>`` can be built,
linked as an executable, and then run. The ``<code>`` must contain at least
a ``main()`` function, or in Fortran a ``program``.
The result is stored in the internal cache variable specified by
``<resultVar>``. Success of build and run is indicated by boolean ``true``.
Failure to build or run is indicated by boolean ``false`` such as an empty
string or an error message.
By default, the test source file will be given a file extension that matches
the requested language. The ``SRC_EXT`` option can be used to override this
@@ -47,12 +49,6 @@ subsequently be run.
end program"
HAVE_COARRAY)
The check is only performed once, with the result cached in the variable named
by ``<resultVar>``. Every subsequent CMake run will reuse this cached value
rather than performing the check again, even if the ``<code>`` changes. In
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_source_runs()``