fish-shell/sphinx_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
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 17:05:09 +08:00			`.. _cmd-break:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`break - stop the current inner loop`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`===================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: Use command labels [ci skip] 2019-03-31 17:07:59 +08: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-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			There are no parameters for ``break``.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08: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 11:14:04 +08: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-17 05:08:41 +08:00			`end`
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00