Help: Check*SourceCompiles, Check*CompilerFlag refer to new command

The CheckSourceCompiles and CheckCompilerFlag would generally be preferred general
command syntax, but users may not realize they exist, so help point them there.
This commit is contained in:
Michael Hirsch
2024-08-13 12:38:05 -04:00
parent 2904ce00d2
commit 5d42177a06
15 changed files with 30 additions and 0 deletions

View File

@@ -27,6 +27,8 @@ 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.
See also :command:`check_compiler_flag` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_c_compiler_flag()``

View File

@@ -28,6 +28,8 @@ Check once if C source code can be built.
``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
functions must be declared as usual.
See also :command:`check_source_compiles` for a more general command syntax.
See also :command:`check_source_runs` to run compiled source.
The compile and link commands can be influenced by setting any of the

View File

@@ -27,6 +27,8 @@ subsequently be run.
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
See also :command:`check_source_runs` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_c_source_runs()``:

View File

@@ -21,6 +21,8 @@ A positive result from this check indicates only that the compiler did not
issue a diagnostic message when given the flag. Whether the flag has any
effect or even a specific one is beyond the scope of this module.
See also :command:`check_compiler_flag` for a more general command syntax.
.. note::
Since the :command:`try_compile` command forwards flags from variables
like :variable:`CMAKE_CXX_FLAGS <CMAKE_<LANG>_FLAGS>`, unknown flags

View File

@@ -28,6 +28,8 @@ Check once if C++ source code can be built.
``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
functions must be declared as usual.
See also :command:`check_source_compiles` for a more general command syntax.
See also :command:`check_source_runs` to run compiled source.
The compile and link commands can be influenced by setting any of the

View File

@@ -27,6 +27,8 @@ subsequently be run.
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
See also :command:`check_source_runs` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_cxx_source_runs()``:

View File

@@ -29,6 +29,8 @@ 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.
See also :command:`check_compiler_flag` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_fortran_compiler_flag()``

View File

@@ -30,6 +30,8 @@ Check once if Fortran source code can be built.
``SRC_EXT`` option can be used to override this with ``.<extension>`` instead--
``.F90`` is a typical choice.
See also :command:`check_source_compiles` for a more general command syntax.
See also :command:`check_source_runs` to run compiled source.
Internally, :command:`try_compile` is used to compile the source. If

View File

@@ -49,6 +49,8 @@ subsequently be run.
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
See also :command:`check_source_runs` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_fortran_source_runs()``:

View File

@@ -29,6 +29,8 @@ 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.
See also :command:`check_compiler_flag` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_objc_compiler_flag()``

View File

@@ -30,6 +30,8 @@ Check once if Objective-C source can be built.
``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
functions must be declared as usual.
See also :command:`check_source_compiles` for a more general command syntax.
See also :command:`check_source_runs` to run compiled source.
The compile and link commands can be influenced by setting any of the

View File

@@ -29,6 +29,8 @@ subsequently be run.
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
See also :command:`check_source_runs` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_objc_source_runs()``

View File

@@ -29,6 +29,8 @@ 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.
See also :command:`check_compiler_flag` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_objcxx_compiler_flag()``

View File

@@ -30,6 +30,8 @@ Check once if Objective-C++ source can be built.
``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
functions must be declared as usual.
See also :command:`check_source_compiles` for a more general command syntax.
See also :command:`check_source_runs` to run compiled source.
The compile and link commands can be influenced by setting any of the

View File

@@ -29,6 +29,8 @@ subsequently be run.
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
See also :command:`check_source_runs` for a more general command syntax.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_objcxx_source_runs()``