diff options
author | Brad King <brad.king@kitware.com> | 2003-04-04 15:56:11 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2003-04-04 15:56:11 (GMT) |
commit | a56ddb5823285f1ae17f0c46632971ca9f02bbbf (patch) | |
tree | f5470b833eef35a1e7bd6dbcc1aa6a976f8650c9 /Source/cmSetCommand.h | |
parent | f6e87dc2f686e510bd698b7de0fe392bfe1d52f8 (diff) | |
download | CMake-a56ddb5823285f1ae17f0c46632971ca9f02bbbf.zip CMake-a56ddb5823285f1ae17f0c46632971ca9f02bbbf.tar.gz CMake-a56ddb5823285f1ae17f0c46632971ca9f02bbbf.tar.bz2 |
ENH: Added CACHE entry types to documentation string.
Diffstat (limited to 'Source/cmSetCommand.h')
-rw-r--r-- | Source/cmSetCommand.h | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h index f93f4dd..38ee16b 100644 --- a/Source/cmSetCommand.h +++ b/Source/cmSetCommand.h @@ -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."; } |