diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | Doc/Zsh/compsys.yo | 12 |
2 files changed, 11 insertions, 6 deletions
@@ -1,3 +1,8 @@ +2015-03-04 Peter Stephenson <p.stephenson@samsung.com> + + * Daniel Shahaf: 34640: Doc/Zsh/compsys.yo: clarify + documentation for _guard function. + 2015-03-03 Peter Stephenson <p.stephenson@samsung.com> * Matthew Martin: 34637: Completion/BSD/Command/_mixerctl: diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo index 5890f1704..89cd05121 100644 --- a/Doc/Zsh/compsys.yo +++ b/Doc/Zsh/compsys.yo @@ -4278,12 +4278,12 @@ option `tt(-)tt(-help)'. ) findex(_guard) item(tt(_guard) [ var(options) ] var(pattern descr))( -This function is intended to be used in the var(action) for -the specifications passed to tt(_arguments) and similar functions. It -returns immediately with a non-zero return status if -the string to be completed does not match the var(pattern). If the -pattern matches, the var(descr) is displayed; the function then returns -status zero if the word to complete is not empty, non-zero otherwise. +This function displays var(descr) if var(pattern) matches the string to +be completed. It is intended to be used in the var(action) for the +specifications passed to tt(_arguments) and similar functions. + +The return status is zero if the message was displayed and the word to +complete is not empty, and non-zero otherwise. The var(pattern) may be preceded by any of the options understood by tt(compadd) that are passed down from tt(_description), namely tt(-M), |