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 | |
| parent | 1f15613899dc28150911da2dba7758b262644468 (diff) | |
| download | zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.gz zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.zip | |
Phil Pennock: 26312: Document no variables altered on failed match
Diffstat (limited to 'Doc/Zsh')
| -rw-r--r-- | Doc/Zsh/cond.yo | 2 | ||||
| -rw-r--r-- | Doc/Zsh/mod_pcre.yo | 4 | ||||
| -rw-r--r-- | Doc/Zsh/mod_regex.yo | 4 |
3 files changed, 8 insertions, 2 deletions
diff --git a/Doc/Zsh/cond.yo b/Doc/Zsh/cond.yo index 1a4d5a71c..9d8f145f8 100644 --- a/Doc/Zsh/cond.yo +++ b/Doc/Zsh/cond.yo @@ -115,6 +115,8 @@ var(regexp). If the option tt(RE_MATCH_PCRE) is set var(regexp) is tested as a PCRE regular expression using the tt(zsh/pcre) module, else it is tested as a POSIX extended regular expression using the tt(zsh/regex) module. +Upon successful match, some variables will be updated; no variables +are changed if the matching fails. If the option tt(BASH_REMATCH) is set the array tt(BASH_REMATCH) is set to the substring that matched the pattern followed by the substrings that matched parenthesised 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() diff --git a/Doc/Zsh/mod_regex.yo b/Doc/Zsh/mod_regex.yo index 08e92ab9f..4081810ed 100644 --- a/Doc/Zsh/mod_regex.yo +++ b/Doc/Zsh/mod_regex.yo @@ -8,9 +8,11 @@ startitem() findex(regex-match) item(var(expr) tt(-regex-match) var(regex))( Matches a string against a POSIX extended regular expression. -The matched portion of the string will normally be placed in the tt(MATCH) +On successful match, +matched portion of the string will normally be placed in the tt(MATCH) variable. If there are any capturing parentheses within the regex, then the tt(match) array variable will contain those. +If the match is not successful, then the variables will not be altered. For example, |