CMake/Help/command/break.rst

break
-----

Break from an enclosing foreach or while loop.

.. code-block:: cmake

  break()

Breaks from an enclosing :command:`foreach` or :command:`while` loop.

See also the :command:`continue` command.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 15:17:36 +00:00			`break`
			`-----`

			`Break from an enclosing foreach or while loop.`

Help: Revise docs on Scripting Commands Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only 2018-10-16 19:50:48 +00:00			`.. code-block:: cmake`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 15:17:36 +00:00
			`break()`

Help: Revise docs on Scripting Commands Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only 2018-10-16 19:50:48 +00:00			Breaks from an enclosing :command:`foreach` or :command:`while` loop.
continue: Add a new CMake language command for loop continuation (#14013) Inspired-by: Doug Barbieri Signed-off-by: Gregor Jasny <gjasny@googlemail.com> 2014-11-29 16:56:18 +00:00
			See also the :command:`continue` command.