[m-dev.] for review: improve doc for compiler options

[Mark Anthony BROWN]

Fergus Henderson writes:
> 
> Estimated hours taken: 1.5
> 
> Rearrange and improve the documentation of the compilation model and
> code generation options.
> 
> doc/user_guide.texi:
> compiler/options.m:
> 	- Move the `--max-jump-table-size' option to the code generation
> 	  options section, since this option is not a compilation model
> 	  option (it doesn't affect binary compatibility).
> 	- Move the compilation model options that are not intended for general
> 	  use into a new subsection "developer compilation model options".
> 	- Move the code generation options that are used for optimizing
> 	  the generated C code based on the target architecture
> 	  (these happen to also be all the ones that are not intended for

Just a minor niggle, but "these also happen to be..." would be
better, IMHO.

> 	  general use) into a new subsection "code generation target options".
> 	- Add line breaks, i.e. "$*" in TexInfo, after all the

s/$*/@*/

> 	  "(This option is not intended for general use.)" statements.
> 
> compiler/options.m:
> 	- Move the `--have-delay-slot' and `--num-real-{r,f}-{regs,temps}'
> 	  options to the code generation options section, since these option

s/these option/these options/

> 	  are not a compilation model option (they don't affect binary
> 	  compatibility).  These options were already in the code generation
> 	  options section in user_guide.texi.
> 	- Fix a layout error in the help message for `--output-grade-string'.
> 
> doc/user_guide.texi:
> 	Document the `--no-reclaim-heap-on-failure' option.  Previously
> 	this was documented in options.m but not in user_guide.texi.
> 

The diff looks fine.

Cheers,
Mark.

-- 
Mark Brown  (dougl at cs.mu.oz.au)       )O+   |  For Microsoft to win,
MEngSc student,                             |  the customer must lose
Dept of Computer Science, Melbourne Uni     |          -- Eric S. Raymond
--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to:       mercury-developers at cs.mu.oz.au
Administrative Queries: owner-mercury-developers at cs.mu.oz.au
Subscriptions:          mercury-developers-request at cs.mu.oz.au
--------------------------------------------------------------------------