fish-shell/doc_src/cmds/end.rst
Fabian Boehm 38b24c2325 docs: Use :doc: role when linking to commands
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.
2022-09-24 10:56:43 +02:00

34 lines
952 B
ReStructuredText

.. _cmd-end:
end - end a block of commands
=============================
Synopsis
--------
.. synopsis::
begin
[COMMANDS ...]
end
.. synopsis::
function NAME [OPTIONS]; COMMANDS ...; end
if CONDITION; COMMANDS_TRUE ...; [else; COMMANDS_FALSE ...;] end
switch VALUE; [case [WILDCARD ...]; [COMMANDS ...]; ...] end
while CONDITION; COMMANDS ...; end
for VARNAME in [VALUES ...]; COMMANDS ...; end
Description
-----------
The **end** keyword ends a block of commands started by one of the following commands:
- :doc:`begin <begin>` to start a block of commands
- :doc:`function <function>` to define a function
- :doc:`if <if>`, :doc:`switch <switch>` to conditionally execute commands
- :doc:`while <while>`, :doc:`for <for>` to perform commands multiple times
The **end** keyword does not change the current exit status.
Instead, the status after it will be the status returned by the most recent command.