diff options
| author | Peter Stephenson <pws@users.sourceforge.net> | 2009-01-15 09:49:06 +0000 |
|---|---|---|
| committer | Peter Stephenson <pws@users.sourceforge.net> | 2009-01-15 09:49:06 +0000 |
| commit | 3af9307d1428a20718e8a0ace3242c5d2dd0a43b (patch) | |
| tree | 9d7a4aead4364e2aeeeefa470100591c6566c24c /Doc/Zsh/mod_pcre.yo | |
| parent | 1f15613899dc28150911da2dba7758b262644468 (diff) | |
| download | zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.gz zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.xz zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.zip | |
Phil Pennock: 26312: Document no variables altered on failed match
Diffstat (limited to 'Doc/Zsh/mod_pcre.yo')
| -rw-r--r-- | Doc/Zsh/mod_pcre.yo | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/Zsh/mod_pcre.yo b/Doc/Zsh/mod_pcre.yo index f6131f5e4..33b864478 100644 --- a/Doc/Zsh/mod_pcre.yo +++ b/Doc/Zsh/mod_pcre.yo @@ -26,13 +26,15 @@ item(tt(pcre_match) [ tt(-v) var(var) ] [ tt(-a) var(arr) ] var(string))( Returns successfully if tt(string) matches the previously-compiled PCRE. -If the expression captures substrings within parentheses, +Upon successful match, +if the expression captures substrings within parentheses, tt(pcre_match) will set the array var($match) to those substrings, unless the tt(-a) option is given, in which case it will set the array var(arr). Similarly, the variable var(MATCH) will be set to the entire matched portion of the string, unless the tt(-v) option is given, in which case the variable var(var) will be set. +No variables are altered if there is no successful match. ) enditem() |