Merge topic 'fix-8154-improve-list-documentation'

2d14b15 Clarify list subcommand documentation (#8154)
This commit is contained in:
Brad King 2011-02-22 14:30:25 -05:00 committed by CMake Topic Stage
commit b346093a03
1 changed files with 8 additions and 0 deletions

View File

@ -83,6 +83,14 @@ public:
"REMOVE_DUPLICATES will remove duplicated items in the list.\n"
"REVERSE reverses the contents of the list in-place.\n"
"SORT sorts the list in-place alphabetically.\n"
"The list subcommands APPEND, INSERT, REMOVE_AT, REMOVE_ITEM, "
"REMOVE_DUPLICATES, REVERSE and SORT may create new values for "
"the list within the current CMake variable scope. Similar to "
"the SET command, the LIST command creates new variable values "
"in the current scope, even if the list itself is actually "
"defined in a parent scope. To propagate the results of these "
"operations upwards, use SET with PARENT_SCOPE, SET with CACHE "
"INTERNAL, or some other means of value propagation.\n"
"NOTES: A list in cmake is a ; separated group of strings. "
"To create a list the set command can be used. For example, "
"set(var a b c d e) creates a list with a;b;c;d;e, and "