cmake/Help/command/mark_as_advanced.rst

29 lines
867 B
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
mark_as_advanced
----------------
Mark cmake cached variables as advanced.
2019-11-11 23:01:05 +01:00
.. code-block:: cmake
2014-08-03 19:52:23 +02:00
2019-11-11 23:01:05 +01:00
mark_as_advanced([CLEAR|FORCE] <var1> ...)
2014-08-03 19:52:23 +02:00
2019-11-11 23:01:05 +01:00
Sets the advanced/non-advanced state of the named
cached variables.
2014-08-03 19:52:23 +02:00
2019-11-11 23:01:05 +01:00
An advanced variable will not be displayed in any
of the cmake GUIs unless the ``show advanced`` option is on.
In script mode, the advanced/non-advanced state has no effect.
If the keyword ``CLEAR`` is given
then advanced variables are changed back to unadvanced.
If the keyword ``FORCE`` is given
then the variables are made advanced.
If neither ``FORCE`` nor ``CLEAR`` is specified,
new values will be marked as advanced, but if a
variable already has an advanced/non-advanced state,
it will not be changed.
2020-08-30 11:54:41 +02:00
2021-09-14 00:13:48 +02:00
.. versionchanged:: 3.17
Variables passed to this command which are not already in the cache
are ignored. See policy :policy:`CMP0102`.