about summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authorNuri Jung <jnooree@gmail.com>2020-07-07 13:26:53 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2020-07-07 13:27:03 +0000
commit89618fe37d0c6568b1b42e237057278e686005d6 (patch)
tree4a80ae610e2b2426e3822466a4b66c85d9e8a0a7 /Doc
parent4ab0d047c7539f306d32edbcefa791870a783e75 (diff)
downloadzsh-89618fe37d0c6568b1b42e237057278e686005d6.tar.gz
zsh-89618fe37d0c6568b1b42e237057278e686005d6.tar.xz
zsh-89618fe37d0c6568b1b42e237057278e686005d6.zip
github #58: docs: Note that the zsh/regex syntax is platform-dependent.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/mod_regex.yo12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/Zsh/mod_regex.yo b/Doc/Zsh/mod_regex.yo
index f20451664..40ee92785 100644
--- a/Doc/Zsh/mod_regex.yo
+++ b/Doc/Zsh/mod_regex.yo
@@ -26,5 +26,17 @@ tt(-regex-match) operator.
 
 If tt(BASH_REMATCH) is set, then the array tt(BASH_REMATCH) will be set
 instead of tt(MATCH) and tt(match).
+
+Note that the tt(zsh/regex) module logic relies on the host system. The 
+same var(expr) and var(regex) pair could produce different results on different
+platforms if a var(regex) with non-standard syntax is given.
+
+For example, no syntax for matching a word boundary is defined in the POSIX
+extended regular expression standard. GNU tt(libc) and BSD tt(libc) both provide 
+such syntaxes as extensions (tt(\b) and tt([[:<:]])/tt([[:>:]]) respectively), 
+but neither of these syntaxes is supported by both of these implementations.
+
+Refer to the manref(regcomp)(3) and manref(re_format)(7) manual pages on your
+system for locally-supported syntax.
 )
 enditem()