summaryrefslogtreecommitdiff
path: root/share/cmake-3.22/Help/command/while.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.22/Help/command/while.rst')
-rw-r--r--share/cmake-3.22/Help/command/while.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/share/cmake-3.22/Help/command/while.rst b/share/cmake-3.22/Help/command/while.rst
new file mode 100644
index 0000000..a4957c1
--- /dev/null
+++ b/share/cmake-3.22/Help/command/while.rst
@@ -0,0 +1,25 @@
+while
+-----
+
+Evaluate a group of commands while a condition is true
+
+.. code-block:: cmake
+
+ while(<condition>)
+ <commands>
+ endwhile()
+
+All commands between while and the matching :command:`endwhile` are recorded
+without being invoked. Once the :command:`endwhile` is evaluated, the
+recorded list of commands is invoked as long as the ``<condition>`` is true.
+
+The ``<condition>`` has the same syntax and is evaluated using the same logic
+as described at length for the :command:`if` command.
+
+The commands :command:`break` and :command:`continue` provide means to
+escape from the normal control flow.
+
+Per legacy, the :command:`endwhile` command admits
+an optional ``<condition>`` argument.
+If used, it must be a verbatim repeat of the argument of the opening
+``while`` command.