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

(elp-report-limit, elp-restore-all, elp-unset-master, elp-results): Fix typos.

Browse source 
(elp-sort-by-function, elp-use-standard-output, elp-recycle-buffers-p):
Doc fixes.
This commit is contained in:
Juanma Barranquero 2007-10-31 12:09:33 +00:00
parent 7837948ffc
commit 1cc5b8f8b4
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lisp/emacs-lisp/elp.el
View file

@ -147,16 +147,16 @@ Results are displayed with the `elp-results' command."
:group 'elp) :group 'elp)
(defcustom elp-sort-by-function 'elp-sort-by-total-time (defcustom elp-sort-by-function 'elp-sort-by-total-time
"*Non-nil specifies elp results sorting function. "*Non-nil specifies ELP results sorting function.
These functions are currently available: These functions are currently available:
elp-sort-by-call-count -- sort by the highest call count elp-sort-by-call-count -- sort by the highest call count
elp-sort-by-total-time -- sort by the highest total time elp-sort-by-total-time -- sort by the highest total time
elp-sort-by-average-time -- sort by the highest average times elp-sort-by-average-time -- sort by the highest average times
You can write you're own sort function. It should adhere to the You can write your own sort function. It should adhere to the
interface specified by the PRED argument for the `sort' defun. Each interface specified by the PREDICATE argument for `sort'.
\"element of LIST\" is really a 4 element vector where element 0 is Each \"element of LIST\" is really a 4 element vector where element 0 is
the call count, element 1 is the total time spent in the function, the call count, element 1 is the total time spent in the function,
element 2 is the average time spent in the function, and element 3 is element 2 is the average time spent in the function, and element 3 is
the symbol's name string." the symbol's name string."
@ -164,7 +164,7 @@ the symbol's name string."
:group 'elp) :group 'elp)
(defcustom elp-report-limit 1 (defcustom elp-report-limit 1
"*Prevents some functions from being displayed in the results buffer. "*Prevent some functions from being displayed in the results buffer.
If a number, no function that has been called fewer than that number If a number, no function that has been called fewer than that number
of times will be displayed in the output buffer. If nil, all of times will be displayed in the output buffer. If nil, all
functions will be displayed." functions will be displayed."
@ -173,12 +173,12 @@ functions will be displayed."
:group 'elp) :group 'elp)
(defcustom elp-use-standard-output nil (defcustom elp-use-standard-output nil
"*Non-nil says to output to `standard-output' instead of a buffer." "*If non-nil, output to `standard-output' instead of a buffer."
:type 'boolean :type 'boolean
:group 'elp) :group 'elp)
(defcustom elp-recycle-buffers-p t (defcustom elp-recycle-buffers-p t
"*nil says to not recycle the `elp-results-buffer'. "*If nil, don't recycle the `elp-results-buffer'.
In other words, a new unique buffer is create every time you run In other words, a new unique buffer is create every time you run
\\[elp-results]." \\[elp-results]."
:type 'boolean :type 'boolean
@ -372,7 +372,7 @@ Use optional LIST if provided instead."
(mapcar 'elp-restore-function list))) (mapcar 'elp-restore-function list)))
(defun elp-restore-all () (defun elp-restore-all ()
"Restores the original definitions of all functions being profiled." "Restore the original definitions of all functions being profiled."
(interactive) (interactive)
(elp-restore-list elp-all-instrumented-list)) (elp-restore-list elp-all-instrumented-list))
@ -412,7 +412,7 @@ Use optional LIST if provided instead."
(elp-instrument-function funsym))) (elp-instrument-function funsym)))
(defun elp-unset-master () (defun elp-unset-master ()
"Unsets the master function." "Unset the master function."
(interactive) (interactive)
;; when there's no master function, recording is turned on by default. ;; when there's no master function, recording is turned on by default.
(setq elp-master nil (setq elp-master nil
@ -558,7 +558,7 @@ original definition, use \\[elp-restore-function] or \\[elp-restore-all]."
(defun elp-results () (defun elp-results ()
"Display current profiling results. "Display current profiling results.
If `elp-reset-after-results' is non-nil, then current profiling If `elp-reset-after-results' is non-nil, then current profiling
information for all instrumented functions are reset after results are information for all instrumented functions is reset after results are
displayed." displayed."
(interactive) (interactive)
(let ((curbuf (current-buffer)) (let ((curbuf (current-buffer))