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

[Fergus Henderson]

Thanks for the review, Mark.  I made all the changes you suggest.
I also made a few more minor changes to fix formatting errors
in the help message (see the relative diff below), so I changed
the log message slightly, replacing the line

	- Fix a layout error in the help message for `--output-grade-string'.

with

	- Fix a few minor layout error in the options help message.
 
I will commit this change now.

--- options.m.old	Thu Apr 22 16:20:03 1999
+++ options.m	Thu Apr 22 16:26:56 1999
@@ -1459,7 +1459,7 @@
 :- pred options_help_aux_output(io__state::di, io__state::uo) is det.
 
 options_help_aux_output -->
-	io__write_string("\n Auxiliary Output Options:\n"),
+	io__write_string("\nAuxiliary Output Options:\n"),
 	write_tabbed_lines([
 		"--no-assume-gmake",
 		"\tWhen generating `.dep' files, generate Makefile",
@@ -1683,15 +1683,18 @@
 ********************/
 		"--debug\t\t\t\t(grade modifier: `.debug')",
 		"\tEnable Mercury-level debugging.",
-		"\tSee the Debugging chapter of the Mercury User's Guide for details.",
+		"\tSee the Debugging chapter of the Mercury User's Guide",
+		"\tfor details.",
 		"--pic-reg\t\t\t(grade modifier: `.pic_reg')",
 		"[For Unix with intel x86 architecture only]",
 		"\tSelect a register usage convention that is compatible,",
 		"\twith position-independent code (gcc's `-fpic' option).",
 		"\tThis is necessary when using shared libraries on Intel x86",
-		"\tsystems running Unix.  On other systems it has no effect.",
+		"\tsystems running Unix.  On other systems it has no effect."
+	]),
 
-	"Developer compilation model options:",
+	io__write_string("\n    Developer compilation model options:\n"),
+	write_tabbed_lines([
 		"--tags {none, low, high}\t(This option is not for general use.)",
 		"\tSpecify whether to use the low bits or the high bits of ",
 		"\teach word as tag bits (default: low).",
@@ -1824,9 +1827,11 @@
 		"--fact-table-hash-percent-full <percentage>",
 		"\tSpecify how full the `pragma fact_table' hash tables should be",
 		"\tallowed to get.  Given as an integer percentage",
-		"\t(valid range: 1 to 100, default: 90).",
+		"\t(valid range: 1 to 100, default: 90)."
+	]),
 
-	"Code generation target options:",
+	io__write_string("\n    Code generation target options:\n"),
+	write_tabbed_lines([
 		"--branch-delay-slot\t\t(This option is not for general use.)",
 		"\tAssume that branch instructions have a delay slot.",
 		"--num-real-r-regs <n>\t\t(This option is not for general use.)",

-- 
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.
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------