GC documentation tweaks

  * Fold documentation of (SETF GC-LOGFILE) into that of GC-LOGFILE.

  * Document default value of GENERATION-NUMBER-OF-GCS-BEFORE-PROMOTION.

  * Order the dictionary entries in the manual's GC section more logically.
    I hope.

diff --git a/doc/manual/beyond-ansi.texinfo b/doc/manual/beyond-ansi.texinfo
index 9e62530..08b942b 100644 (file)
--- a/doc/manual/beyond-ansi.texinfo
+++ b/doc/manual/beyond-ansi.texinfo
@@ -58,7 +58,7 @@ Extensions}.
 @include var-sb-ext-star-gc-run-time-star.texinfo
 @include fun-sb-ext-bytes-consed-between-gcs.texinfo
 @include fun-sb-ext-dynamic-space-size.texinfo
-@include fun-sb-ext-setf-gc-logfile.texinfo
+@include fun-sb-ext-get-bytes-consed.texinfo
 @include fun-sb-ext-gc-logfile.texinfo
 @include fun-sb-ext-generation-average-age.texinfo
 @include fun-sb-ext-generation-bytes-allocated.texinfo
@@ -66,7 +66,6 @@ Extensions}.
 @include fun-sb-ext-generation-minimum-age-before-gc.texinfo
 @include fun-sb-ext-generation-number-of-gcs-before-promotion.texinfo
 @include fun-sb-ext-generation-number-of-gcs.texinfo
-@include fun-sb-ext-get-bytes-consed.texinfo
 
 @node Metaobject Protocol
 @comment  node-name,  next,  previous,  up

diff --git a/src/code/gc.lisp b/src/code/gc.lisp
index e1ebb73..6dbc4f8 100644 (file)
--- a/src/code/gc.lisp
+++ b/src/code/gc.lisp
@@ -157,10 +157,6 @@ run in any thread.")
 (progn
   (sb!alien:define-alien-variable ("gc_logfile" %gc-logfile) (* char))
   (defun (setf gc-logfile) (pathname)
-    "Use PATHNAME to log garbage collections. If non-null, the
-designated file is opened before and after each collection, and
-generation statistics are appended to it. To stop writing the log, use
-NIL as the pathname."
     (let ((new (when pathname
                  (sb!alien:make-alien-string
                   (native-namestring (translate-logical-pathname pathname)
@@ -170,7 +166,11 @@ NIL as the pathname."
       (when old
         (sb!alien:free-alien old))))
   (defun gc-logfile ()
-    "Return the name of the current GC logfile."
+    #!+sb-doc
+    "Return the pathname used to log garbage collections. Can be SETF.
+Default is NIL, meaning collections are not logged. If non-null, the
+designated file is opened before and after each collection, and generation
+statistics are appended to it."
     (let ((val %gc-logfile))
       (when val
         (native-pathname (cast val c-string)))))
@@ -435,8 +435,8 @@ Experimental: interface subject to change."
     t)
   (def number-of-gcs-before-promotion
       "Number of times garbage collection is done on GENERATION before
-automatic promotion to the next generation is triggered. Can be assigned to
-using SETF. Available on GENCGC platforms only.
+automatic promotion to the next generation is triggered. Default is 1. Can be
+assigned to using SETF. Available on GENCGC platforms only.
 
 Experimental: interface subject to change."
     t)