[m-rev.] for review: <correction of comment in mlds.m>

[Nicholas David WATMOUGH]

Estimated hours takes: 0.1

mercury/compiler/mlds.m:
	Corrected documentation for the field constructor of the
	mlds__lval discriminated union. This involved changing the name of
	the example variable from FieldName to FieldId and the
	corresponding explananation of the variable.

Index: mlds.m
===================================================================
RCS file: /home/mercury1/repository/mercury/compiler/mlds.m,v
retrieving revision 1.77
diff -u -r1.77 mlds.m
--- mlds.m	8 Nov 2001 11:47:59 -0000	1.77
+++ mlds.m	19 Dec 2001 04:30:52 -0000
@@ -1301,15 +1301,16 @@
 	%
 	--->	field(maybe(mlds__tag), mlds__rval, field_id, 
 			mlds__type, mlds__type)
-				% field(Tag, Address, FieldName, FieldType,
+				% field(Tag, Address, FieldId, FieldType,
 				%	PtrType)
 				% selects a field of a compound term.
 				% Address is a tagged pointer to a cell
-				% on the heap; the offset into the cell
-				% is FieldNum words. If Tag is yes, the
-				% arg gives the value of the tag; if it is
-				% no, the tag bits will have to be masked off.
-				% The value of the tag should be given if
+				% on the heap; the position in the cell, 
+				% FieldId, is represented either as a field 
+				% name or a number of words offset. If Tag is 
+				% yes, the arg gives the value of the tag; if 
+				% it is no, the tag bits will have to be masked
+				% off. The value of the tag should be given if
 				% it is known, since this will lead to
 				% faster code.
 				% The FieldType is the type of the field.


Thanks
Nic

--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------