diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 15:17:36 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-15 18:12:03 (GMT) |
| commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
| tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/mark_as_advanced.rst | |
| parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
| download | CMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2 | |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Help/command/mark_as_advanced.rst')
| -rw-r--r-- | Help/command/mark_as_advanced.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Help/command/mark_as_advanced.rst b/Help/command/mark_as_advanced.rst new file mode 100644 index 0000000..30b1289 --- /dev/null +++ b/Help/command/mark_as_advanced.rst @@ -0,0 +1,19 @@ +mark_as_advanced +---------------- + +Mark cmake cached variables as advanced. + +:: + + mark_as_advanced([CLEAR|FORCE] VAR [VAR2 ...]) + +Mark the named cached variables as advanced. An advanced variable +will not be displayed in any of the cmake GUIs unless the show +advanced option is on. If CLEAR is the first argument advanced +variables are changed back to unadvanced. If FORCE is the first +argument, then the variable is made advanced. If neither FORCE nor +CLEAR is specified, new values will be marked as advanced, but if the +variable already has an advanced/non-advanced state, it will not be +changed. + +It does nothing in script mode. |