Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
[PATCH] docs: compsys: Clarify documentation of the 'filter' style.
- X-seq: zsh-workers 38155
- From: Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: [PATCH] docs: compsys: Clarify documentation of the 'filter' style.
- Date: Tue, 15 Mar 2016 00:06:48 +0000
- List-help: <mailto:zsh-workers-help@zsh.org>
- List-id: Zsh Workers List <zsh-workers.zsh.org>
- List-post: <mailto:zsh-workers@zsh.org>
- Mailing-list: contact zsh-workers-help@xxxxxxx; run by ezmlm
---
A user on IRC misunderstood the incumbent text as describing «ldapsearch
mail=<TAB>», although we don't ship an ldapsearch completion.
The function «_email_addresses» isn't documented in the man pages yet, only in
source code comments. I'm leaving that for future work.
Cheers,
Daniel
Doc/Zsh/compsys.yo | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 2aa0740..d478e81 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -1554,7 +1554,8 @@ of the links themselves.
)
kindex(filter, completion style)
item(tt(filter))(
-This is used by the LDAP plugin for e-mail address completion to specify
+The tt(ldap) plugin of email address completion (see tt(_email_addresses)) uses
+this style to specify
the attributes to match against when filtering entries. So for example, if
the style is set to `tt(sn)', matching is done against surnames. Standard
LDAP filtering is used so normal completion matching is bypassed. If this
Messages sorted by:
Reverse Date,
Date,
Thread,
Author