Commits

Anonymous committed 0b6576b

profile.el: Doc fixes.

Comments (0)

Files changed (2)

+2000-03-04  Martin Buchholz  <martin@xemacs.org>
+
+	* profile.el: Doc fixes.
+
 2000-01-13  Andreas Jaeger  <aj@suse.de>
 
 	* regexp-opt.el: Moved to package xemacs-base since other packages
 
 ;; The profiler works by catching "ticks" (actually SIGPROF signals),
 ;; and looking at the current Lisp function, at the time of each tick.
-;; The output of this process is an alist with keys being the
-;; functions, and values being the number of ticks per function.  From
-;; this, `profiling-results' easily extracts the total number of
+;; The output of this process is a hash table with keys being the
+;; functions, and values being the number of ticks per function.
+;; `profile-results' pretty-prints this information.
 ;; Unless stated otherwise, profiling info is being accumulated
 ;; incrementally through several profile runs (the current info is
 ;; always available by `get-profiling-info').  Use
 ;;    function+descendants time;
 ;; 2) Each tick is equivalent to 1ms (which can be changed), but this
 ;;    is CPU time (user+kernel), not the real time;
-;; 3) Only the actuall funcalls are profiled.  If a subr Ffoo calls
+;; 3) Only the actual funcalls are profiled.  If a subr Ffoo calls
 ;;    Fbar using Fbar (), only Ffoo will appear in the profile.
 
 ;; A typical profiling session consists of using `clear-profiling-info'
 ;; followed by `profile' or `profile-key-sequence', followed by
-;; `profiling-results'.
+;; `profile-results'.
 
 ;; For instance, to see where Gnus spends time when generating Summary
 ;; buffer, go to the group buffer, and press `M-x clear-profiling-info'
   (or table
       (setq table call-count-profile-table))
   (let (list)
-    ;; Convert the hashtable to a list
+    ;; Convert the hash table to a list
     (maphash (lambda (key value)
 	       (push (cons key value) list))
 	     table)
 PROFILE was called, it will be turned off after FORMS are evaluated.
 Otherwise, profiling will be left running.
 
-Returns the profiling info, printable by `profiling-results'."
+Returns the profiling info, printable by `profile-results'."
   `(let ((was-profiling (profiling-active-p)))
      (unwind-protect
 	 (progn