summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorscivision <scivision@users.noreply.github.com>2023-03-08 00:23:49 -0500
committerscivision <scivision@users.noreply.github.com>2023-03-14 16:48:25 -0400
commitcf48022dc52fe5dd8161d591e4fb8b1f076ce52e (patch)
tree33952b87053838b87543466889a1fcd95e13a545 /Help
parent7d43bcb4db2b26d9f9f8d828198252a44b5560a0 (diff)
downloadcmake-cf48022dc52fe5dd8161d591e4fb8b1f076ce52e.tar.gz
Help:Check*: include CMAKE_REQUIRED_* vars to dedupe
CMAKE_REQUIRED_FLAGS now notes that space-delimited string, not ;-list is required, which could be surprising compared to similar options that do use ;-list
Diffstat (limited to 'Help')
-rw-r--r--Help/module/CMAKE_REQUIRED_DEFINITIONS.txt4
-rw-r--r--Help/module/CMAKE_REQUIRED_FLAGS.txt6
-rw-r--r--Help/module/CMAKE_REQUIRED_INCLUDES.txt4
-rw-r--r--Help/module/CMAKE_REQUIRED_LIBRARIES.txt5
-rw-r--r--Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt5
-rw-r--r--Help/module/CMAKE_REQUIRED_QUIET.txt5
6 files changed, 29 insertions, 0 deletions
diff --git a/Help/module/CMAKE_REQUIRED_DEFINITIONS.txt b/Help/module/CMAKE_REQUIRED_DEFINITIONS.txt
new file mode 100644
index 0000000000..17289c378a
--- /dev/null
+++ b/Help/module/CMAKE_REQUIRED_DEFINITIONS.txt
@@ -0,0 +1,4 @@
+ ``CMAKE_REQUIRED_DEFINITIONS``
+ A :ref:`;-list <CMake Language Lists>` of compiler definitions of the form
+ ``-DFOO`` or ``-DFOO=bar``. A definition for the name specified by
+ ``<resultVar>`` will also be added automatically.
diff --git a/Help/module/CMAKE_REQUIRED_FLAGS.txt b/Help/module/CMAKE_REQUIRED_FLAGS.txt
new file mode 100644
index 0000000000..80ae23999b
--- /dev/null
+++ b/Help/module/CMAKE_REQUIRED_FLAGS.txt
@@ -0,0 +1,6 @@
+ ``CMAKE_REQUIRED_FLAGS``
+ String of additional flags to pass to the compiler. The string must be
+ space-delimited--a :ref:`;-list <CMake Language Lists>` will not work.
+ The contents of :variable:`CMAKE_<LANG>_FLAGS <CMAKE_<LANG>_FLAGS>` and
+ its associated configuration-specific variable are automatically added
+ to the compiler command before the contents of ``CMAKE_REQUIRED_FLAGS``.
diff --git a/Help/module/CMAKE_REQUIRED_INCLUDES.txt b/Help/module/CMAKE_REQUIRED_INCLUDES.txt
new file mode 100644
index 0000000000..c8993bbfce
--- /dev/null
+++ b/Help/module/CMAKE_REQUIRED_INCLUDES.txt
@@ -0,0 +1,4 @@
+ ``CMAKE_REQUIRED_INCLUDES``
+ A :ref:`;-list <CMake Language Lists>` of header search paths to pass to
+ the compiler. These will be the only header search paths used--the contents
+ of the :prop_dir:`INCLUDE_DIRECTORIES` directory property will be ignored.
diff --git a/Help/module/CMAKE_REQUIRED_LIBRARIES.txt b/Help/module/CMAKE_REQUIRED_LIBRARIES.txt
new file mode 100644
index 0000000000..8611b9edf6
--- /dev/null
+++ b/Help/module/CMAKE_REQUIRED_LIBRARIES.txt
@@ -0,0 +1,5 @@
+ ``CMAKE_REQUIRED_LIBRARIES``
+ A :ref:`;-list <CMake Language Lists>` of libraries to add to the link
+ command. These can be the name of system libraries or they can be
+ :ref:`Imported Targets <Imported Targets>` (see :command:`try_compile` for
+ further details).
diff --git a/Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt b/Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt
new file mode 100644
index 0000000000..f2a2474374
--- /dev/null
+++ b/Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt
@@ -0,0 +1,5 @@
+ ``CMAKE_REQUIRED_LINK_OPTIONS``
+ .. versionadded:: 3.14
+
+ A :ref:`;-list <CMake Language Lists>` of options to add to the link
+ command (see :command:`try_compile` for further details).
diff --git a/Help/module/CMAKE_REQUIRED_QUIET.txt b/Help/module/CMAKE_REQUIRED_QUIET.txt
new file mode 100644
index 0000000000..aae8059f6d
--- /dev/null
+++ b/Help/module/CMAKE_REQUIRED_QUIET.txt
@@ -0,0 +1,5 @@
+ ``CMAKE_REQUIRED_QUIET``
+ .. versionadded:: 3.1
+
+ If this variable evaluates to a boolean true value, all status messages
+ associated with the check will be suppressed.