mirror/ zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2024-05-31 20:36:03 +02:00
Code

39044 (in part, see thread): Document _canonical_paths in the manual, too. 

This mostly copy-pastes the source code comments and adds markup, however, the
positional arguments are now annotated optional, and a ')' was added.
This commit is contained in:
Daniel Shahaf 2016-08-16 22:48:41 +00:00
parent 062aeca2d2
commit 0aa6bfd831
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2016-08-18 Daniel Shahaf <d.s@daniel.shahaf.name>
* 39044 (in part, see thread): Doc/Zsh/compsys.yo: Document
_canonical_paths in the manual, too.
2016-08-15 Peter Stephenson <p.stephenson@samsung.com>
* 39039: Doc/Zsh/zle.yo: fix documentation for transpose-words.

15
Doc/Zsh/compsys.yo
View File

@ -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