From: Mark Wooding <mdw@distorted.org.uk>
Date: Sun, 10 Jan 2016 03:00:53 +0000 (+0000)
Subject: src/class-output.lisp (*instance-class*): Add a docstring.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/sod/commitdiff_plain/4b856491b9fa0bbeda9772b7b834071dfe1c9f56

src/class-output.lisp (*instance-class*): Add a docstring.
---

diff --git a/src/class-output.lisp b/src/class-output.lisp
index 1b69f69..aea85d4 100644
--- a/src/class-output.lisp
+++ b/src/class-output.lisp
@@ -392,7 +392,15 @@ (defmethod hook-output progn ((choff chain-offset)
 ;;; Implementation output.
 
 (export '*instance-class*)
-(defvar *instance-class*)
+(defvar *instance-class* nil
+  "The class currently being output.
+
+   This is bound during the `hook-output' traversal of a class layout for
+   `:c' output, since some of the objects traversed actually `belong' to
+   superclasses and there's no other way to find out what the reference class
+   actually is.
+
+   It may be bound at other times.")
 
 (defmethod hook-output progn ((class sod-class) (reason (eql :c)) sequencer)
   (sequence-output (stream sequencer)