Fix doc strings of 2 time.el variables.

 lisp/time.el (display-time-load-average)
 (display-time-default-load-average): Doc fixes.  See the thread starting at
 http://lists.gnu.org/archive/html/help-gnu-emacs/2012-01/msg00059.html
 for the details.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index ba9886a33e234ccb44f8a605db77c15b728a89fe..39007b7e0d4ed2c83c2caf330b69d2b651e61d08 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,11 @@
+2012-01-06  Eli Zaretskii  <eliz@gnu.org>
+
+       * time.el (display-time-load-average)
+       (display-time-default-load-average): Doc fixes.  See the thread
+       starting at
+       http://lists.gnu.org/archive/html/help-gnu-emacs/2012-01/msg00059.html
+       for the details.
+
 2012-01-06  Glenn Morris  <rgm@gnu.org>
 
        * mail/unrmail.el (unrmail): Give an explicit error if the input file

diff --git a/lisp/time.el b/lisp/time.el
index f611aa175435ee25647f75a91a1a3560140f04a4..c7fa5927e48724fe3522f433c8831a07099c7f6b 100644 (file)
--- a/lisp/time.el
+++ b/lisp/time.el
@@ -64,13 +64,14 @@ directory `display-time-mail-directory' contains nonempty files."
 
 (defcustom display-time-default-load-average 0
   "Which load average value will be shown in the mode line.
-Almost every system can provide values of load for past 1 minute, past 5 or
-past 15 minutes.  The default is to display 1 minute load average.
+Almost every system can provide values of load for the past 1 minute,
+past 5 or past 15 minutes.  The default is to display 1-minute load average.
 The value can be one of:
 
   0   => 1 minute load
   1   => 5 minutes load
-  2   => 15 minutes load"
+  2   => 15 minutes load
+  nil => None (do not display the load average)"
   :type '(choice (const :tag "1 minute load" 0)
                 (const :tag "5 minutes load" 1)
                 (const :tag "15 minutes load" 2)
@@ -78,8 +79,10 @@ The value can be one of:
   :group 'display-time)
 
 (defvar display-time-load-average nil
-  "Load average currently being shown in mode line.
-See `display-time-default-load-average'.")
+  "Value of the system's load average currently shown on the mode line.
+See `display-time-default-load-average'.
+
+This is an internal variable; setting it has no effect.")
 
 (defcustom display-time-load-average-threshold 0.1
   "Load-average values below this value won't be shown in the mode line."