kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ENH: Added CACHE entry types to documentation string.

This commit is contained in:
Brad King 2003-04-04 10:56:11 -05:00
parent f6e87dc2f6
commit a56ddb5823
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Source/cmSetCommand.h
View File

@ -70,12 +70,18 @@ public:
" SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
"Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR "
"is set to it. If CACHE is present, then the VAR is put in the cache. "
"TYPE and DOCSTRING are required. TYPE may be BOOL, PATH, FILEPATH, "
"STRING, INTERNAL, or STATIC. If TYPE is INTERNAL, then the "
"VALUE is Always written into the cache, replacing any values "
"existing in the cache. If it is not a CACHE VAR, then this always "
"writes into the current makefile. The FORCE option will overwrite"
"the CACHE value removing any changes from the USER.\n"
"TYPE and DOCSTRING are required. TYPE is used by the CMake GUI to "
"choose a widget with which the user sets a value. The value for TYPE "
"may be one of\n"
" FILEPATH = File chooser dialog.\n"
" PATH = Directory chooser dialog.\n"
" STRING = Arbitrary string.\n"
" BOOL = Boolean ON/OFF checkbox.\n"
" INTERNAL = No GUI entry (used for persistent variables).\n"
"If TYPE is INTERNAL, then the VALUE is always written into the cache, "
"replacing any values existing in the cache. If it is not a CACHE VAR, "
"then this always writes into the current makefile. The FORCE option "
"will overwrite the CACHE value removing any changes by the USER.\n"
" SET(VAR VALUE1 ... VALUEN).\n"
"In this case VAR is set to a ; separated list of values.";
}