Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-09-22 23:42:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document problems with event handlers and autoloading

Browse source 
Fixes #845.
This commit is contained in:
Fabian Homborg 2015-08-10 18:52:37 +02:00
parent 53456b5fc3
commit 9828d787fa
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc_src/index.hdr.in
View file

@ -251,6 +251,8 @@ The default value for `$fish_function_path` is `~/.config/fish/functions` `/etc/
It is very important that function definition files only contain the definition for the specified function and nothing else. Otherwise, it is possible that autoloading a function files requires that the function already be loaded, which creates a circular dependency.
Autoloading also won't work for <a href=#event>event handlers</a>, since fish cannot know that a function is supposed to be executed when an event occurs when it hasn't yet loaded the function.
\subsubsection syntax-conditional Conditional execution of code and flow control
@ -1113,6 +1115,8 @@ function --on-signal WINCH my_signal_handler
end
\endfish
Please note that event handlers only become active when a function is loaded which means you might need to manually <a href='commands.html#source'>source</a> a function's file instead of relying on <a href=#syntax-function-autoloading>autoloading</a>.
For more information on how to define new event handlers, see the documentation for the <a href='commands.html#function'>function</a> command.