[m-rev.] trivial diff: mlds.m: document max_stack_size

[Fergus Henderson]

Estimated hours taken: 0.25
Branches: main

compiler/mlds.m:
	Copy the relevant documentation about the `max_stack_size'
	attribute from the Mercury language reference manual.

Workspace: /mnt/earth/home/earth/fjh/ws-earth4/mercury
Index: compiler/mlds.m
===================================================================
RCS file: /home/mercury1/repository/mercury/compiler/mlds.m,v
retrieving revision 1.81
diff -u -d -r1.81 mlds.m
--- compiler/mlds.m	2002/01/28 05:30:24	1.81
+++ compiler/mlds.m	2002/01/29 01:49:36
@@ -1258,6 +1258,13 @@
 
 :- type target_code_attribute
 	--->	max_stack_size(int).
+		% max_stack_size(Size):
+		% This attribute declares the maximum stack usage of a
+		% particular piece of code.  The unit that `Size' is measured
+		% in depends upon foreign language being used.  Currently this
+		% attribute is only used (and is in fact required) by the
+		% `IL' foreign language interface, and is measured in units
+		% of stack items.
 
 	%
 	% constructor id

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
The University of Melbourne         |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------