[Emacs-diffs] /srv/bzr/emacs/trunk r106802: Fix doc strings of 2 time.el variables.

[Eli Zaretskii]

------------------------------------------------------------
revno: 106802
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Fri 2012-01-06 11:43:59 +0200
message:
  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.
modified:
  lisp/ChangeLog
  lisp/time.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-01-06 08:34:47 +0000
+++ b/lisp/ChangeLog    2012-01-06 09:43:59 +0000
@@ -1,3 +1,11 @@
+2012-01-06  Eli Zaretskii  <address@hidden>
+
+       * 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  <address@hidden>
 
        * mail/unrmail.el (unrmail): Give an explicit error if the input file

=== modified file 'lisp/time.el'
--- a/lisp/time.el      2012-01-06 07:45:55 +0000
+++ b/lisp/time.el      2012-01-06 09:43:59 +0000
@@ -64,13 +64,14 @@
 
 (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 @@
   :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."