mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-23 02:12:08 +08:00
38b24c2325
This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
41 lines
842 B
ReStructuredText
41 lines
842 B
ReStructuredText
.. _cmd-break:
|
|
|
|
break - stop the current inner loop
|
|
===================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
LOOP_CONSTRUCT
|
|
[COMMANDS ...]
|
|
break
|
|
[COMMANDS ...]
|
|
end
|
|
|
|
Description
|
|
-----------
|
|
|
|
``break`` halts a currently running loop (*LOOP_CONSTRUCT*), such as a :doc:`for <for>` or :doc:`while <while>` loop. It is usually added inside of a conditional block such as an :doc:`if <if>` block.
|
|
|
|
There are no parameters for ``break``.
|
|
|
|
Example
|
|
-------
|
|
The following code searches all .c files for "smurf", and halts at the first occurrence.
|
|
|
|
::
|
|
|
|
for i in *.c
|
|
if grep smurf $i
|
|
echo Smurfs are present in $i
|
|
break
|
|
end
|
|
end
|
|
|
|
See Also
|
|
--------
|
|
|
|
- the :doc:`continue <continue>` command, to skip the remainder of the current iteration of the current inner loop
|