[m-dev.] diff: Compiler support for stack_layouts

[Tyson Dowd]

On 10-Dec-1997, Fergus Henderson <fjh at cs.mu.oz.au> wrote:
> On 10-Dec-1997, Tyson Dowd <trd at cs.mu.oz.au> wrote:
> > > options.m:
> > > > +	io__write_string("\t--stack-layout\n"),
> > > > +	io__write_string("\t(This option is not for general use.)\n"),
> > > > +	io__write_string("\t\tGenerate stack_layout structures.\n"),
> > > 
> > > Did you document this in user_guide.texi?
> > 
> > No. This is for "development" use only at the moment.
> 
> The intent is that the documentation in `mmc --help' and hence in
> the man page (which is produced automatically from the output of
> `mmc --help') should be identical with the documentation in the
> User's Guide.  So the option should either be documented, or
> not documented -- it should not be documented in one place
> and not documented in the other place.
> 
> If something is only for use by developers, then put the documentation
> in options.m, but comment it out.  The developers will have to read
> the source code.

I'll commit this with the other changes.

===================================================================


Estimated hours taken: 0.03

compiler/options.m:
	Comment out the documentation of the stack-layouts option,
	as it is a developer only option.


Index: compiler/options.m
===================================================================
RCS file: /home/staff/zs/imp/mercury/compiler/options.m,v
retrieving revision 1.212
diff -u -r1.212 options.m
--- options.m	1997/12/05 15:47:46	1.212
+++ options.m	1997/12/10 04:15:27
@@ -1442,10 +1446,11 @@
 	io__write_string("\t\tDon't output base_type_layout structures or references\n"),
 	io__write_string("\t\tto them. (The C code also needs to be compiled with\n"),
 	io__write_string("\t\t`-DNO_TYPE_LAYOUT').\n"),
-
-	io__write_string("\t--stack-layout\n"),
-	io__write_string("\t(This option is not for general use.)\n"),
-	io__write_string("\t\tGenerate stack_layout structures.\n"),
+	
+		% This is a developer only option at the moment.
+%	io__write_string("\t--stack-layout\n"),
+%	io__write_string("\t(This option is not for general use.)\n"),
+%	io__write_string("\t\tGenerate stack_layout structures.\n"),
 
 	io__write_string("\t--unboxed-float\n"),
 	io__write_string("\t(This option is not for general use.)\n"),



-- 
       Tyson Dowd           # 
                            #         Linux versus Windows is a 
     trd at cs.mu.oz.au        #            Win lose situation.
http://www.cs.mu.oz.au/~trd #