Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-27 05:13:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarify block command documentation

Browse source
This commit is contained in:
Giorgio Gallo 2024-04-22 18:21:10 +02:00 committed by Fabian Boehm
parent 24f0abe780
commit 8a1eae4640
1 changed files with 4 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc_src/cmds/block.rst
View file

@ -14,15 +14,11 @@ Synopsis
Description Description
----------- -----------
``block`` prevents events triggered by ``fish`` or the :doc:`emit <emit>` command from being delivered and acted upon while the block is in place. ``block`` delays delivery of all events triggered by ``fish`` or the :doc:`emit <emit>`, thus delaying the execution of any function registered ``--on-event``, ``--on-process-exit``, ``--on-job-exit``, ``--on-variable`` and ``--on-signal`` until after the block is removed.
In functions, ``block`` can be useful while performing work that should not be interrupted by the shell.
The block can be removed. Any events which triggered while the block was in place will then be delivered.
Event blocks should not be confused with code blocks, which are created with ``begin``, ``if``, ``while`` or ``for`` Event blocks should not be confused with code blocks, which are created with ``begin``, ``if``, ``while`` or ``for``
Without options, the ``block`` command acts with function scope. Without options, ``block`` sets up a block that is released automatically at the end of the current function scope.
The following options are available: The following options are available:
@ -36,7 +32,7 @@ The following options are available:
Release global block. Release global block.
**-h** or **--help** **-h** or **--help**
Displays help about using this command. Display help about using this command.
Example Example
------- -------
@ -57,4 +53,4 @@ Example
Notes Notes
----- -----
Events are only received from the current fish process as there is no way to send events from one fish process to another (yet). Events are only received from the current fish process as there is no way to send events from one fish process to another.