summaryrefslogtreecommitdiffstats
path: root/Doc/Zsh/mod_regex.yo
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2009-01-15 09:49:06 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2009-01-15 09:49:06 +0000
commit3af9307d1428a20718e8a0ace3242c5d2dd0a43b (patch)
tree9d7a4aead4364e2aeeeefa470100591c6566c24c /Doc/Zsh/mod_regex.yo
parent26304: Mikael Magnusson: change tense in link warning (diff)
downloadzsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar
zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.gz
zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.bz2
zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.lz
zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.xz
zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.tar.zst
zsh-3af9307d1428a20718e8a0ace3242c5d2dd0a43b.zip
Phil Pennock: 26312: Document no variables altered on failed match
Diffstat (limited to 'Doc/Zsh/mod_regex.yo')
-rw-r--r--Doc/Zsh/mod_regex.yo4
1 files changed, 3 insertions, 1 deletions
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,