aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2006-05-06 07:53:25 +0000
committerEli Zaretskii2006-05-06 07:53:25 +0000
commit321eb4b29a0cd5899f0ff7633f86935e9167175f (patch)
tree18bedfbae6ba92e0a0f2b0fed8a47bab9610d450
parent41f7a85e0d33a63df8c1a4cac61fc3ee8b123d7c (diff)
downloademacs-321eb4b29a0cd5899f0ff7633f86935e9167175f.tar.gz
emacs-321eb4b29a0cd5899f0ff7633f86935e9167175f.zip
(Minibuffer History): Document add-to-history.
-rw-r--r--lispref/minibuf.texi18
1 files changed, 17 insertions, 1 deletions
diff --git a/lispref/minibuf.texi b/lispref/minibuf.texi
index 4faf8fd374c..dd96a020057 100644
--- a/lispref/minibuf.texi
+++ b/lispref/minibuf.texi
@@ -449,11 +449,27 @@ list, put the length in the @code{history-length} property of the
449history list symbol. The variable @code{history-delete-duplicates} 449history list symbol. The variable @code{history-delete-duplicates}
450specifies whether to delete duplicates in history. 450specifies whether to delete duplicates in history.
451 451
452@defun add-to-history history-var newelt &optional maxelt keep-dups
453This function adds a new element @var{newelt} to the history list
454stored in the variable @var{history-var}, and returns the updated
455history list. By default, the list length is limited by the value
456specified by @code{history-length} (described below), but the optional
457argument @var{maxelt} overrides that. The possible values of
458@var{maxelt} have the same meaning as the values of
459@code{history-length}.
460
461Duplicate members are removed from the history list, unless
462@code{history-delete-duplicates} is @code{nil} or the second optional
463argument of this function @var{keep-dups} is non-@code{nil}.
464@end defun
465
452@defvar history-length 466@defvar history-length
453The value of this variable specifies the maximum length for all 467The value of this variable specifies the maximum length for all
454history lists that don't specify their own maximum lengths. If the 468history lists that don't specify their own maximum lengths. If the
455value is @code{t}, that means there no maximum (don't delete old 469value is @code{t}, that means there no maximum (don't delete old
456elements). 470elements). The value of @code{history-length} property of the history
471list variable's symbol, if set, overrides this variable for that
472particular history list.
457@end defvar 473@end defvar
458 474
459@defvar history-delete-duplicates 475@defvar history-delete-duplicates