summaryrefslogtreecommitdiff
path: root/share/cmake-3.22/Help/command/mark_as_advanced.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.22/Help/command/mark_as_advanced.rst')
-rw-r--r--share/cmake-3.22/Help/command/mark_as_advanced.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/share/cmake-3.22/Help/command/mark_as_advanced.rst b/share/cmake-3.22/Help/command/mark_as_advanced.rst
new file mode 100644
index 0000000..201363f
--- /dev/null
+++ b/share/cmake-3.22/Help/command/mark_as_advanced.rst
@@ -0,0 +1,28 @@
+mark_as_advanced
+----------------
+
+Mark cmake cached variables as advanced.
+
+.. code-block:: cmake
+
+ mark_as_advanced([CLEAR|FORCE] <var1> ...)
+
+Sets the advanced/non-advanced state of the named
+cached variables.
+
+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.
+
+.. versionchanged:: 3.17
+ Variables passed to this command which are not already in the cache
+ are ignored. See policy :policy:`CMP0102`.