mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-24 05:03:26 +08:00
c2efb3efcd
Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
21 lines
757 B
ReStructuredText
21 lines
757 B
ReStructuredText
get_cmake_property
|
|
------------------
|
|
|
|
Get a global property of the CMake instance.
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_cmake_property(<var> <property>)
|
|
|
|
Gets a global property from the CMake instance. The value of
|
|
the ``<property>`` is stored in the variable ``<var>``.
|
|
If the property is not found, ``<var>`` will be set to ``"NOTFOUND"``.
|
|
See the :manual:`cmake-properties(7)` manual for available properties.
|
|
|
|
See also the :command:`get_property` command ``GLOBAL`` option.
|
|
|
|
In addition to global properties, this command (for historical reasons)
|
|
also supports the :prop_dir:`VARIABLES` and :prop_dir:`MACROS` directory
|
|
properties. It also supports a special ``COMPONENTS`` global property that
|
|
lists the components given to the :command:`install` command.
|