Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Workers List List-Post: List-Help: X-Qmail-Scanner-Diagnostics: from hermes.apache.org by f.primenet.com.au (envelope-from , uid 7791) with qmail-scanner-2.11 (clamdscan: 0.99.2/21882. spamassassin: 3.4.1. Clear:RC:0(140.211.11.3):SA:0(-0.5/5.0):. Processed in 0.169288 secs); 16 Aug 2016 22:55:26 -0000 X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on f.primenet.com.au X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, RP_MATCHES_RCVD autolearn=unavailable autolearn_force=no version=3.4.1 X-Envelope-From: danielsh@apache.org X-Qmail-Scanner-Mime-Attachments: | X-Qmail-Scanner-Zip-Files: | Received-SPF: none (ns1.primenet.com.au: domain at apache.org does not designate permitted sender hosts) From: Daniel Shahaf To: zsh-workers@zsh.org Subject: [PATCH] Document _canonical_paths. Date: Tue, 16 Aug 2016 22:48:41 +0000 Message-Id: <1471387721-5256-1-git-send-email-danielsh@tarsus.local2> X-Mailer: git-send-email 2.1.4 X-Seq: zsh-workers 39044 This mostly copy-pastes and adds markup, however, the positional arguments are now annotated optional, and a ')' was added. --- Completion/Unix/Type/_canonical_paths | 13 ------------- Doc/Zsh/compsys.yo | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/Completion/Unix/Type/_canonical_paths b/Completion/Unix/Type/_canonical_paths index e4a725b..7dc6b78 100644 --- a/Completion/Unix/Type/_canonical_paths +++ b/Completion/Unix/Type/_canonical_paths @@ -1,18 +1,5 @@ #autoload -# This completion function completes all paths given to it, and also tries to -# offer completions which point to the same file as one of the paths given -# (relative path when an absolute path is given, and vice versa; when ..'s are -# present in the word to be completed, and some paths got from symlinks. - -# Usage: _canonical_paths [-A var] [-N] [-MJV12nfX] tag desc paths... - -# -A, if specified, takes the paths from the array variable specified. Paths can -# also be specified on the command line as shown above. -N, if specified, -# prevents canonicalizing the paths given before using them for completion, in -# case they are already so. `tag' and `desc' arguments are well, obvious :) In -# addition, the options -M, -J, -V, -1, -2, -n, -F, -X are passed to compadd. - _canonical_paths_pwd() { # Get the canonical directory name by changing to it. integer chaselinks diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo index 41864f8..8c7ef0f 100644 --- a/Doc/Zsh/compsys.yo +++ b/Doc/Zsh/compsys.yo @@ -2978,6 +2978,21 @@ widgets to find out if the command line hasn't changed since the last time completion was tried. Only then are the tt(_ignored), tt(_correct) and tt(_approximate) completers called. ) +findex(_canonical_paths) +item(tt(_canonical_paths) [ tt(-A) var(var) ] [ tt(-N) ] [ tt(-MJV12nfX) ] var(tag) var(descr) [ var(paths) ... ])( +This completion function completes all paths given to it, and also tries to +offer completions which point to the same file as one of the paths given +(relative path when an absolute path is given, and vice versa; when tt(..)'s +are present in the word to be completed; and some paths got from symlinks). + +tt(-A), if specified, takes the paths from the array variable specified. Paths can +also be specified on the command line as shown above. tt(-N), if specified, +prevents canonicalizing the paths given before using them for completion, in +case they are already so. The options tt(-M), tt(-J), tt(-V), tt(-1), tt(-2), +tt(-n), tt(-F), tt(-X) are passed to tt(compadd). + +See tt(_description) for a description of var(tag) and var(descr). +) findex(_complete) item(tt(_complete))( This completer generates all possible completions in a context-sensitive