# HG changeset patch
# User Aidan Kehoe <kehoea@parhasard.net>
# Date 1308497837 -3600
# Node ID 05c1ad4f7a7b04ab226b7960ec603550097e3f22
# Parent  bcd74c477a387f6a7ea62cf0244af98635c473ac
Expand the documentation of #'eq-hash, mention the CL PRINT-OBJECT protocol

2011-06-19  Aidan Kehoe  <kehoea@parhasard.net>

	* elhash.c (Feq_hash):
	Document that this returns, for non-immediate objects, a value
	that is unique among currently-reachable objects.

diff -r bcd74c477a38 -r 05c1ad4f7a7b src/ChangeLog
--- a/src/ChangeLog	Sat Jun 04 14:17:59 2011 +0100
+++ b/src/ChangeLog	Sun Jun 19 16:37:17 2011 +0100
@@ -1,3 +1,9 @@
+2011-06-19  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* elhash.c (Feq_hash):
+	Document that this returns, for non-immediate objects, a value
+	that is unique among currently-reachable objects.
+
 2011-05-29  Didier Verna  <didier@xemacs.org>
 
 	* console-impl.h (struct console_methods): Remove device parameter
diff -r bcd74c477a38 -r 05c1ad4f7a7b src/elhash.c
--- a/src/elhash.c	Sat Jun 04 14:17:59 2011 +0100
+++ b/src/elhash.c	Sun Jun 19 16:37:17 2011 +0100
@@ -2008,6 +2008,10 @@
 
 DEFUN ("eq-hash", Feq_hash, 1, 1, 0, /*
 Return a hash value for OBJECT appropriate for use with `eq.'
+
+If OBJECT is not immediate (it is not a fixnum or character) this hash value
+will be unique among currently-reachable objects, and is appropriate for
+implementing the Common Lisp PRINT-OBJECT protocol.
 */
        (object))
 {