procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix doc strings of 2 time.el variables.

Browse source 
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.
This commit is contained in:
Eli Zaretskii 2012-01-06 11:43:59 +02:00
parent 24ea72d3eb
commit 4afee9d5fd
2 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lisp/ChangeLog
View file

@ -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

13
lisp/time.el
View file

@ -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."