summaryrefslogtreecommitdiffstats
path: root/Source
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2011-02-22 19:30:25 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2011-02-22 19:30:25 (GMT)
commitb346093a030887b4e7fd0c35c5b2535ad3093dba (patch)
treeba74ffbf2a2b3f7d18a8cf0676f2b41af3f28f33 /Source
parent4d8fee46598d857410a3960aa2d352ebae45cdfc (diff)
parent2d14b15ec22a83ef78b0b9f1e5947f281e35d11a (diff)
downloadCMake-b346093a030887b4e7fd0c35c5b2535ad3093dba.zip
CMake-b346093a030887b4e7fd0c35c5b2535ad3093dba.tar.gz
CMake-b346093a030887b4e7fd0c35c5b2535ad3093dba.tar.bz2
Merge topic 'fix-8154-improve-list-documentation'
2d14b15 Clarify list subcommand documentation (#8154)
Diffstat (limited to 'Source')
-rw-r--r--Source/cmListCommand.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/Source/cmListCommand.h b/Source/cmListCommand.h
index 7f229fa..d215295 100644
--- a/Source/cmListCommand.h
+++ b/Source/cmListCommand.h
@@ -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 "