From 2d14b15ec22a83ef78b0b9f1e5947f281e35d11a Mon Sep 17 00:00:00 2001 From: David Cole Date: Mon, 7 Feb 2011 16:55:07 -0500 Subject: Clarify list subcommand documentation (#8154) Make it clear that list subcommands that modify the list do so in the current CMake variable scope, regardless of the original scope of the list variable involved. --- Source/cmListCommand.h | 8 ++++++++ 1 file changed, 8 insertions(+) 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 " -- cgit v0.12