[Emacs-diffs] Changes to emacs/doc/lispref/os.texi,v

[Miles Bader]

CVSROOT:        /cvsroot/emacs
Module name:    emacs
Changes by:     Miles Bader <miles>     07/10/27 09:07:17

Index: doc/lispref/os.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/doc/lispref/os.texi,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- doc/lispref/os.texi 9 Oct 2007 05:05:39 -0000       1.3
+++ doc/lispref/os.texi 27 Oct 2007 09:07:15 -0000      1.4
@@ -1561,10 +1561,10 @@
 
 @c Emacs 19 feature
 @defun current-idle-time
-This function returns the length of time Emacs has been idle, as a
-list of three integers: @code{(@var{high} @var{low} @var{microsec})}.
-The integers @var{high} and @var{low} combine to give the number of
-seconds of idleness, which is
+If Emacs is idle, this function returns the length of time Emacs has
+been idle, as a list of three integers: @code{(@var{high} @var{low}
address@hidden)}.  The integers @var{high} and @var{low} combine to
+give the number of seconds of idleness, which is
 @ifnottex
 @var{high} * 2**16 + @var{low}.
 @end ifnottex
@@ -1576,6 +1576,9 @@
 start of the current second (or 0 for systems that return time with
 the resolution of only one second).
 
+When Emacs is not idle, @code{current-idle-time} returns @code{nil}.
+This is a convenient way to test whether Emacs is idle.
+
 The main use of this function is when an idle timer function wants to
 ``take a break'' for a while.  It can set up another idle timer to
 call the same function again, after a few seconds more idleness.