fish-shell/doc_src/cmds/break.rst

.. _cmd-break:

break - stop the current inner loop
===================================

Synopsis
--------

| loop_construct
|    [*COMMANDS* ...]
|    **break**
|    [*COMMANDS* ...]
| end

Description
-----------

``break`` halts a currently running loop, such as a :ref:`switch <cmd-switch>`, :ref:`for <cmd-for>` or :ref:`while <cmd-while>` loop. It is usually added inside of a conditional block such as an :ref:`if <cmd-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 :ref:`continue <cmd-continue>` command, to skip the remainder of the current iteration of the current inner loop
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-break:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`break - stop the current inner loop`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`===================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
More documentation work 2021-12-09 11:53:13 +00:00			`\| loop_construct`
			`\| [COMMANDS ...]`
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-17 23:20:46 +00:00			`\| break`
More documentation work 2021-12-09 11:53:13 +00:00			`\| [COMMANDS ...]`
			`\| end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: Use command labels [ci skip] 2019-03-31 09:07:59 +00:00			``break`` halts a currently running loop, such as a :ref:`switch <cmd-switch>`, :ref:`for <cmd-for>` or :ref:`while <cmd-while>` loop. It is usually added inside of a conditional block such as an :ref:`if <cmd-if>` block.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			There are no parameters for ``break``.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00			`The following code searches all .c files for "smurf", and halts at the first occurrence.`

Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`::`

			`for i in *.c`
			`if grep smurf $i`
			`echo Smurfs are present in $i`
			`break`
			`end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00			`end`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00
doc: add interlinks between `break` and `continue` commands 2020-03-07 14:57:22 +00:00			`See Also`
			`--------`

			- the :ref:`continue <cmd-continue>` command, to skip the remainder of the current iteration of the current inner loop