mirror of
https://github.com/Kitware/CMake.git
synced 2026-08-09 09:12:00 +00:00
e74fbb3d44
Create a stack state for managing diagnostics. This will eventually replace some of the global state used for diagnostics, as well as providing a mechanism to add additional diagnostics. For now, this is only the stack manipulation with a bare minimum of interface logic (in particular, the `block` and `include` commands). Nothing actually looks at the diagnostic state yet, and the primary user interface does not yet exist (although there are some references to it already).
29 lines
1.2 KiB
ReStructuredText
29 lines
1.2 KiB
ReStructuredText
include
|
|
-------
|
|
|
|
Load and run CMake code from a file or module.
|
|
|
|
.. code-block:: cmake
|
|
|
|
include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>]
|
|
[NO_POLICY_SCOPE] [NO_DIAGNOSTIC_SCOPE])
|
|
|
|
Loads and runs CMake code from the file given. Variable reads and
|
|
writes access the scope of the caller (dynamic scoping). If ``OPTIONAL``
|
|
is present, then no error is raised if the file does not exist. If
|
|
``RESULT_VARIABLE`` is given the variable ``<var>`` will be set to the
|
|
full filename which has been included or ``NOTFOUND`` if it failed.
|
|
|
|
If a module is specified instead of a file, the file with name
|
|
``<modulename>.cmake`` is searched first in :variable:`CMAKE_MODULE_PATH`,
|
|
then in the CMake module directory. There is one exception to this: if
|
|
the file which calls ``include()`` is located itself in the CMake builtin
|
|
module directory, then first the CMake builtin module directory is searched and
|
|
:variable:`CMAKE_MODULE_PATH` afterwards. See also policy :policy:`CMP0017`.
|
|
|
|
See the :command:`cmake_policy` command documentation for discussion of the
|
|
``NO_POLICY_SCOPE`` option.
|
|
|
|
See the :command:`cmake_diagnostic` command documentation for discussion of the
|
|
``NO_DIAGNOSTIC_SCOPE`` option.
|