Files
cmake/Help/envvar/CMAKE_SYSTEM_ENVIRONMENT_ACTION.rst
Aiden Woodruff fc3c71d11f cmake: Add cached environment id that triggers reconfigure when changed
The opaque `CMAKE_SYSTEM_ENVIRONMENT_ID` variable is cached during the
first invocation of `cmake` and is a user-defined hint about the state
of the environment. When the value changes, `cmake` either does nothing,
emits a warning (by default), or refreshes the cache as if by `--fresh`.
The action is controlled by the `CMAKE_SYSTEM_ENVIRONMENT_ACTION`
environment variable (which is not cached).

Implements: #28025
2026-08-24 15:06:35 -04:00

25 lines
670 B
ReStructuredText

CMAKE_SYSTEM_ENVIRONMENT_ACTION
-------------------------------
.. versionadded:: 4.5
.. include:: include/ENV_VAR.rst
Specify the action taken by :manual:`cmake(1)` when the value of
:envvar:`CMAKE_SYSTEM_ENVIRONMENT_ID` in the environment does not match the
cached value. If not set, the default is ``WARN``.
The value may be one of:
``IGNORE``
No action is taken.
``WARN``
A warning is emitted to the user.
``REFRESH``
The cache is automatically refreshed, as if by :cmake-option:`--fresh`.
Take care when setting this option, as all cache variables not specified in
a configure preset or the current invocation of :manual:`cmake(1)` will be
lost.