c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
29 lines
865 B
ReStructuredText
29 lines
865 B
ReStructuredText
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.
|
|
|
|
.. versionadded:: 3.17
|
|
Variables passed to this command which are not already in the cache
|
|
are ignored. See policy :policy:`CMP0102`.
|