diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2012-01-06 11:43:59 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2012-01-06 11:43:59 +0200 |
| commit | 4afee9d5fdc053354dc85d650e2d36094fa70209 (patch) | |
| tree | 1de5e30b0c216560a8809f51f231999bf12b616b /lisp/time.el | |
| parent | 24ea72d3eb684ffc74a4ddaa5c77ba394f9c487e (diff) | |
| download | emacs-4afee9d5fdc053354dc85d650e2d36094fa70209.tar.gz | |
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.
Diffstat (limited to 'lisp/time.el')
| -rw-r--r-- | lisp/time.el | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/lisp/time.el b/lisp/time.el index f611aa17543..c7fa5927e48 100644 --- 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." |