mark_as_advanced.rst 867 B

12345678910111213141516171819202122232425262728
  1. mark_as_advanced
  2. ----------------
  3. Mark cmake cached variables as advanced.
  4. .. code-block:: cmake
  5. mark_as_advanced([CLEAR|FORCE] <var1> ...)
  6. Sets the advanced/non-advanced state of the named
  7. cached variables.
  8. An advanced variable will not be displayed in any
  9. of the cmake GUIs unless the ``show advanced`` option is on.
  10. In script mode, the advanced/non-advanced state has no effect.
  11. If the keyword ``CLEAR`` is given
  12. then advanced variables are changed back to unadvanced.
  13. If the keyword ``FORCE`` is given
  14. then the variables are made advanced.
  15. If neither ``FORCE`` nor ``CLEAR`` is specified,
  16. new values will be marked as advanced, but if a
  17. variable already has an advanced/non-advanced state,
  18. it will not be changed.
  19. .. versionchanged:: 3.17
  20. Variables passed to this command which are not already in the cache
  21. are ignored. See policy :policy:`CMP0102`.