From: Richard M. Stallman <rms@gnu.org>
Date: Wed, 24 Oct 2007 08:23:01 +0000 (+0000)
Subject: (Fcurrent_idle_time): Doc fix.
X-Git-Tag: emacs-pretest-22.1.90~518
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3a704bd7e359b1ced7f699b83c8dd6b2d7548cb1;p=emacs.git

(Fcurrent_idle_time): Doc fix.
---

diff --git a/src/keyboard.c b/src/keyboard.c
index 538c0a0d1b0..ffba913fc55 100644
--- a/src/keyboard.c
+++ b/src/keyboard.c
@@ -4612,12 +4612,14 @@ timer_check (do_it_now)
 }
 
 DEFUN ("current-idle-time", Fcurrent_idle_time, Scurrent_idle_time, 0, 0, 0,
-       doc: /* Return the current length of Emacs idleness.
-The value is returned as a list of three integers.  The first has the
+       doc: /* Return the current length of Emacs idleness, or nil.
+The value when Emacs is idle is a list of three integers.  The first has the
 most significant 16 bits of the seconds, while the second has the
 least significant 16 bits.  The third integer gives the microsecond
 count.
 
+The value when Emacs is not idle is nil.
+
 The microsecond count is zero on systems that do not provide
 resolution finer than a second.  */)
   ()