Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: Clarify zshaddhistory doc?



2009/2/18 Peter Stephenson <pws@xxxxxxx>:
> Index: Doc/Zsh/func.yo
> ===================================================================
> RCS file: /cvsroot/zsh/zsh/Doc/Zsh/func.yo,v
> retrieving revision 1.23
> diff -u -r1.23 func.yo
> --- Doc/Zsh/func.yo     5 Sep 2008 09:05:23 -0000       1.23
> +++ Doc/Zsh/func.yo     18 Feb 2009 17:07:35 -0000
> @@ -189,19 +189,23 @@
>  sect(Special Functions)
>  Certain functions, if defined, have special meaning to the shell.
>
> -In the case of tt(chpwd), tt(periodic), tt(precmd) and tt(preexec) it is
> -possible to define an array that has the same name with `tt(_functions)'
> -appended.  Any element in such an array is taken as the name of a function
> -to execute; it is executed in the same context and with the same arguments
> -as the basic function.  For example, if tt($chpwd_functions) is an array
> -containing the values `tt(mychpwd)', `tt(chpwd_save_dirstack)', then the
> -shell attempts to execute the functions `tt(chpwd)', `tt(mychpwd)' and
> +subsect(Hook Functions)
> +findex(functions, hook)
> +findex(hook functions)
> +
> +For the functions below, it is possible to define an array that has the
> +same name as the function with `tt(_functions)' appended.  Any element in
> +such an array is taken as the name of a function to execute; it is executed
> +in the same context and with the same arguments as the basic function.  For
> +example, if tt($chpwd_functions) is an array containing the values
> +`tt(mychpwd)', `tt(chpwd_save_dirstack)', then the shell attempts to
> +execute the functions `tt(chpwd)', `tt(mychpwd)' and
>  `tt(chpwd_save_dirstack)', in that order.  Any function that does not exist
>  is silently ignored.  A function found by this mechanism is referred to
> -elsewhere as a `hook function'.  An error in any function causes
> -subsequent functions not to be run.  Note further that an error
> -in a tt(precmd) hook causes an immediately following tt(periodic)
> -function not to run (thought it may run at the next opportunity).
> +elsewhere as a `hook function'.  An error in any function causes subsequent
> +functions not to be run.  Note further that an error in a tt(precmd) hook
> +causes an immediately following tt(periodic) function not to run (thought
> +it may run at the next opportunity).

Driveby typo fix, thought -> though.


-- 
Mikael Magnusson



Messages sorted by: Reverse Date, Date, Thread, Author