about summary refs log tree commit diff
path: root/Doc/Zsh/compsys.yo
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2003-07-21 17:01:34 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2003-07-21 17:01:34 +0000
commit48205cc72ff7ce3a1470226ae508e5194252db4e (patch)
tree2726d7ddc7ac72cdf7988dc490afcdfa7852d1e7 /Doc/Zsh/compsys.yo
parent7209f6be5a34cfe936a3d14b0bd61a468e830838 (diff)
downloadzsh-48205cc72ff7ce3a1470226ae508e5194252db4e.tar.gz
zsh-48205cc72ff7ce3a1470226ae508e5194252db4e.tar.xz
zsh-48205cc72ff7ce3a1470226ae508e5194252db4e.zip
18859: Allow the sort style to override sorting by setting explicitly to false.
Diffstat (limited to 'Doc/Zsh/compsys.yo')
-rw-r--r--Doc/Zsh/compsys.yo22
1 files changed, 16 insertions, 6 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index e48a057f7..6b77fb8f8 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -2162,12 +2162,22 @@ is started, making it easy to select either of them.
 )
 kindex(sort, completion style)
 item(tt(sort))(
-If set to `true', completing words from the command
-history sorts the words alphabetically instead of
-keeping them in the order in which they appear in the history (from
-youngest to oldest).
-
-This is also used by the tt(_expand) completer. If it is set to
+Many completion widgets call tt(_description) at some point which
+decides whether the matches are added sorted or unsorted (often
+indirectly via tt(_wanted) or tt(_requested)).  This style can be set
+explicitly to one of the usual true or false values as an override.
+If it is not set for the context, the standard behaviour of the
+calling widget is used.
+
+The style is tested first against the full context including the tag, and
+if that fails to produce a value against the context without the tag.
+
+If the calling widget explicitly requests unsorted matches, this is usually
+honoured.  However, the default (unsorted) behaviour of completion
+for the command history may be overridden by setting the style to
+tt(true).
+
+In the tt(_expand) completer, if it is set to
 `true', the expansions generated will always be sorted.  If it is set
 to `tt(menu)', then the expansions are only sorted when they are offered 
 as single strings but not in the string containing all possible