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

[Fergus Henderson]

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.

-- 
Fergus Henderson <fjh at cs.mu.oz.au>   |  "I have always known that the pursuit
WWW: <http://www.cs.mu.oz.au/~fjh>   |  of excellence is a lethal habit"
PGP: finger fjh at 128.250.37.3         |     -- the last words of T. S. Garp.