[movitz-cvs] CVS update: ia-x86/README

[Frode Vatvedt Fjeld]

Update of /project/movitz/cvsroot/ia-x86
In directory common-lisp.net:/tmp/cvs-serv19851

Modified Files:
	README 
Log Message:
*** empty log message ***
Date: Sun Jan 30 10:59:58 2005
Author: ffjeld

Index: ia-x86/README
diff -u ia-x86/README:1.3 ia-x86/README:1.4
--- ia-x86/README:1.3	Sun Jan 30 06:54:33 2005
+++ ia-x86/README	Sun Jan 30 10:59:58 2005
@@ -10,7 +10,7 @@
 ## Author:        Frode Vatvedt Fjeld <frodef at acm.org>
 ## Created at:    Sat Jan 29 16:48:42 2005
 ##                
-## $Id: README,v 1.3 2005/01/30 14:54:33 ffjeld Exp $
+## $Id: README,v 1.4 2005/01/30 18:59:58 ffjeld Exp $
 ##                
 ######################################################################
 
@@ -115,8 +115,10 @@
 just pass zero). Finally, there is the proglist to be encoded to
 machine code. Additionally, the keyword argument :symtab-lookup can
 provide a function that proglist-encode will use to map (otherwise
-undefined) labels to integers. The primary return value is the byte
-vector, while the secondary return value is an (assoc) symbol-table:
+undefined) labels to integers: The function should expect one symbol
+argument and return a suitable integer. The primary return value is
+the byte vector, while the secondary return value is an (assoc)
+symbol-table:
 
   IA-X86(7): (proglist-encode :octet-vector :16-bit #x7c00
                               (read-proglist (mkasm16-bios-print)))
@@ -131,7 +133,7 @@
   IA-X86(8): (asm :movl :eax (:ebx 1))
   => #c(#x894301 #x3)
 
-The return value is a complex, whose real component is the binary
-encoding of the instruction, and the imaginary component is the number
-of bytes.
+The return value is a complex, whose real component is the
+(big-endian) binary encoding of the instruction, and the imaginary
+component is the number of bytes.