about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBarton E. Schaefer <schaefer@zsh.org>2015-11-20 14:15:43 -0800
committerBarton E. Schaefer <schaefer@zsh.org>2015-11-20 14:15:43 -0800
commite59a857b69e8402cca53b3ba1020c44a0b5e46b8 (patch)
tree2d34af1969b7fea758e690614c414d3ce712d775
parentae0420c46a756116fc9a325596275701678d3485 (diff)
downloadzsh-e59a857b69e8402cca53b3ba1020c44a0b5e46b8.tar.gz
zsh-e59a857b69e8402cca53b3ba1020c44a0b5e46b8.tar.xz
zsh-e59a857b69e8402cca53b3ba1020c44a0b5e46b8.zip
unposted: document order of entries for $history and $historywords
-rw-r--r--ChangeLog5
-rw-r--r--Doc/Zsh/mod_parameter.yo6
2 files changed, 10 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index a11455b93..26e0c8403 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2015-11-20  Barton E. Schaefer  <schaefer@zsh.org>
+
+	* unposted: Doc/Zsh/mod_paramter.yo: document order of entries
+	for $history and $historywords
+
 2015-11-20  Mikael Magnusson  <mikachu@gmail.com>
 
 	* 37161: Src/init.c: Disable the heuristic setting RPROMPT_INDENT
diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo
index 9d1dc8b7d..3d260f8e9 100644
--- a/Doc/Zsh/mod_parameter.yo
+++ b/Doc/Zsh/mod_parameter.yo
@@ -123,10 +123,14 @@ directory, the current working directory.
 vindex(history)
 item(tt(history))(
 This associative array maps history event numbers to the full history lines.
+Although it is presented as an associative array, the array of all values
+(tt(${history[@]})) is guaranteed to be returned in order from most recent
+to oldest history event, that is, by decreasing history event number.
 )
 vindex(historywords)
 item(tt(historywords))(
-A special array containing the words stored in the history.
+A special array containing the words stored in the history.  These also
+appear in most to least recent order.
 )
 vindex(jobdirs)
 item(tt(jobdirs))(