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.

15 files changed, 30 insertions, 0 deletions

diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake
index 27b7ae8..696f7a3 100644
--- a/Modules/CheckCCompilerFlag.cmake
+++ b/Modules/CheckCCompilerFlag.cmake
@@ -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()``
 
diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake
index c01b6cf..801cf17 100644
--- a/Modules/CheckCSourceCompiles.cmake
+++ b/Modules/CheckCSourceCompiles.cmake
@@ -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
diff --git a/Modules/CheckCSourceRuns.cmake b/Modules/CheckCSourceRuns.cmake
index e06bcca..1275da5 100644
--- a/Modules/CheckCSourceRuns.cmake
+++ b/Modules/CheckCSourceRuns.cmake
@@ -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()``:
 
diff --git a/Modules/CheckCXXCompilerFlag.cmake b/Modules/CheckCXXCompilerFlag.cmake
index 61ed640..90cd488 100644
--- a/Modules/CheckCXXCompilerFlag.cmake
+++ b/Modules/CheckCXXCompilerFlag.cmake
@@ -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
diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake
index 7c03c4a..c9616d8 100644
--- a/Modules/CheckCXXSourceCompiles.cmake
+++ b/Modules/CheckCXXSourceCompiles.cmake
@@ -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
diff --git a/Modules/CheckCXXSourceRuns.cmake b/Modules/CheckCXXSourceRuns.cmake
index eb643eb..8e84744 100644
--- a/Modules/CheckCXXSourceRuns.cmake
+++ b/Modules/CheckCXXSourceRuns.cmake
@@ -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()``:
 
diff --git a/Modules/CheckFortranCompilerFlag.cmake b/Modules/CheckFortranCompilerFlag.cmake
index 81a2345..94090ef 100644
--- a/Modules/CheckFortranCompilerFlag.cmake
+++ b/Modules/CheckFortranCompilerFlag.cmake
@@ -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()``
 
diff --git a/Modules/CheckFortranSourceCompiles.cmake b/Modules/CheckFortranSourceCompiles.cmake
index 4cbe67a..e9545ab 100644
--- a/Modules/CheckFortranSourceCompiles.cmake
+++ b/Modules/CheckFortranSourceCompiles.cmake
@@ -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
diff --git a/Modules/CheckFortranSourceRuns.cmake b/Modules/CheckFortranSourceRuns.cmake
index 9bf9fb2..9ead9c0 100644
--- a/Modules/CheckFortranSourceRuns.cmake
+++ b/Modules/CheckFortranSourceRuns.cmake
@@ -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()``:
 
diff --git a/Modules/CheckOBJCCompilerFlag.cmake b/Modules/CheckOBJCCompilerFlag.cmake
index f6d259e..f87949b 100644
--- a/Modules/CheckOBJCCompilerFlag.cmake
+++ b/Modules/CheckOBJCCompilerFlag.cmake
@@ -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()``
 
diff --git a/Modules/CheckOBJCSourceCompiles.cmake b/Modules/CheckOBJCSourceCompiles.cmake
index c6e09db..1158b91 100644
--- a/Modules/CheckOBJCSourceCompiles.cmake
+++ b/Modules/CheckOBJCSourceCompiles.cmake
@@ -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
diff --git a/Modules/CheckOBJCSourceRuns.cmake b/Modules/CheckOBJCSourceRuns.cmake
index 511cac6..f2316ce 100644
--- a/Modules/CheckOBJCSourceRuns.cmake
+++ b/Modules/CheckOBJCSourceRuns.cmake
@@ -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()``
 
diff --git a/Modules/CheckOBJCXXCompilerFlag.cmake b/Modules/CheckOBJCXXCompilerFlag.cmake
index 32d50c9..5091a75 100644
--- a/Modules/CheckOBJCXXCompilerFlag.cmake
+++ b/Modules/CheckOBJCXXCompilerFlag.cmake
@@ -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()``
 
diff --git a/Modules/CheckOBJCXXSourceCompiles.cmake b/Modules/CheckOBJCXXSourceCompiles.cmake
index 4a18c21..af3ffde 100644
--- a/Modules/CheckOBJCXXSourceCompiles.cmake
+++ b/Modules/CheckOBJCXXSourceCompiles.cmake
@@ -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
diff --git a/Modules/CheckOBJCXXSourceRuns.cmake b/Modules/CheckOBJCXXSourceRuns.cmake
index 49db3cb..4181113 100644
--- a/Modules/CheckOBJCXXSourceRuns.cmake
+++ b/Modules/CheckOBJCXXSourceRuns.cmake
@@ -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()``