1.0.32.33: GENCGC tuning parameters
[sbcl.git] / src / code / time.lisp
index 6cdb53d..8cf2e00 100644 (file)
@@ -257,8 +257,10 @@ format."
 
 (defvar *gc-run-time* 0
   #!+sb-doc
-  "the total CPU time spent doing garbage collection (as reported by
-   GET-INTERNAL-RUN-TIME)")
+  "Total CPU time spent doing garbage collection (as reported by
+GET-INTERNAL-RUN-TIME.) Initialized to zero on startup. It is safe to bind
+this to zero in order to measure GC time inside a certain section of code, but
+doing so may interfere with results reported by eg. TIME.")
 (declaim (type index *gc-run-time*))
 
 (defun print-time (&key real-time-ms user-run-time-us system-run-time-us