Import readline 7.0 (patch 5)

[deliverable/binutils-gdb.git] / readline / doc / hstech.texi

diff --git a/readline/doc/hstech.texi b/readline/doc/hstech.texi
index 4fc9e8ef1b7fb90e78e8c11c9d96ae1532ded72f..bba7b590eddf5deb96172a5d40375bb81f6045ca 100644 (file)
--- a/readline/doc/hstech.texi
+++ b/readline/doc/hstech.texi
@@ -1,7 +1,7 @@
 @ignore
 This file documents the user interface to the GNU History library.
 
-Copyright (C) 1988-2011 Free Software Foundation, Inc.
+Copyright (C) 1988-2016 Free Software Foundation, Inc.
 Authored by Brian Fox and Chet Ramey.
 
 Permission is granted to make and distribute verbatim copies of this manual
@@ -242,6 +242,7 @@ is greater than the history length, return a @code{NULL} pointer.
 
 @deftypefun time_t history_get_time (HIST_ENTRY *entry)
 Return the time stamp associated with the history entry @var{entry}.
+If the timestamp is missing or invalid, return 0.
 @end deftypefun
 
 @deftypefun int history_total_bytes (void)
@@ -270,9 +271,11 @@ a @code{NULL} pointer.
 @end deftypefun
 
 @deftypefun {HIST_ENTRY *} next_history (void)
-Move the current history offset forward to the next history entry, and
-return the a pointer to that entry.  If there is no next entry, return
-a @code{NULL} pointer.
+If the current history offset refers to a valid history entry,
+increment the current history offset.
+If the possibly-incremented history offset refers to a valid history
+entry, return a pointer to that entry;
+otherwise, return a @code{BNULL} pointer.
 @end deftypefun
 
 @node Searching the History List
@@ -377,7 +380,7 @@ if the returned line should be displayed, but not executed,
 as with the @code{:p} modifier (@pxref{Modifiers}).
 @end table
 
-If an error ocurred in expansion, then @var{output} contains a descriptive
+If an error occurred in expansion, then @var{output} contains a descriptive
 error message.
 @end deftypefun
 
@@ -467,8 +470,8 @@ carriage return, and @samp{=}.
 @end deftypevar
 
 @deftypevar int history_quotes_inhibit_expansion
-If non-zero, single-quoted words are not scanned for the history expansion
-character.  The default value is 0.
+If non-zero, double-quoted words are not scanned for the history expansion
+character or the history comment character.  The default value is 0.
 @end deftypevar
 
 @deftypevar {rl_linebuf_func_t *} history_inhibit_expansion_function