summaryrefslogtreecommitdiffstats
path: root/Source/cmForEachCommand.h
diff options
context:
space:
mode:
authorAndy Cedilnik <andy.cedilnik@kitware.com>2004-04-29 19:12:40 (GMT)
committerAndy Cedilnik <andy.cedilnik@kitware.com>2004-04-29 19:12:40 (GMT)
commit8750f1c277d8bf3fdf2d2986f473c5f09e293ea5 (patch)
treec5db04b06c7c9ae256b6404fab2b664edb1ad5dd /Source/cmForEachCommand.h
parentae50b4bc6afa62663317e630aef509a29c4f9021 (diff)
downloadCMake-8750f1c277d8bf3fdf2d2986f473c5f09e293ea5.zip
CMake-8750f1c277d8bf3fdf2d2986f473c5f09e293ea5.tar.gz
CMake-8750f1c277d8bf3fdf2d2986f473c5f09e293ea5.tar.bz2
ENH: Add RANGE support to FOREACH
Diffstat (limited to 'Source/cmForEachCommand.h')
-rw-r--r--Source/cmForEachCommand.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/Source/cmForEachCommand.h b/Source/cmForEachCommand.h
index bb767e9..64602c9 100644
--- a/Source/cmForEachCommand.h
+++ b/Source/cmForEachCommand.h
@@ -98,12 +98,22 @@ public:
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDFOREACH(loop_var)\n"
+ " FOREACH(loop_var RANGE total)\n"
+ " FOREACH(loop_var RANGE start stop [step])\n"
"All commands between FOREACH and the matching ENDFOREACH are recorded "
"without being invoked. Once the ENDFOREACH is evaluated, the "
"recorded list of commands is invoked once for each argument listed "
"in the original FOREACH command. Each recorded command is modified "
"before invocation to replace any occurrence of \"${loop_var}\" with "
- "the current value in the list.";
+ "the current value in the list.\n"
+ "Foreach can also iterate over the range of numbers generated by "
+ "foreach. There are three types of this iteration:\n"
+ "* When specifying single number, the range will have elements "
+ "0 to \"total\".\n"
+ "* When specifying two numbers, the range will have elements from "
+ "the first number to the second number.\n"
+ "* The third optional number is the increment used to iterate from "
+ "the first number to the second number.";
}
cmTypeMacro(cmForEachCommand, cmCommand);