[m-rev.] for post-commit review: update documentation of the --auto-comments option
Julien Fischer
jfischer at opturion.com
Fri Aug 2 12:59:51 AEST 2019
For post-commit review by anyone.
---------------------------------
Update documentation of the --auto-comments option.
Update the description of the --auto-comments option to reflect that it also
applies to the non-C backends as well as the C backends.
compiler/options.m:
As above.
doc/user_guide.texi:
Update description of --auto-comments.
Delete a couple of stray references to the IL backend.
Julien.
diff --git a/compiler/options.m b/compiler/options.m
index d2b4601..62bbb58 100644
--- a/compiler/options.m
+++ b/compiler/options.m
@@ -4368,7 +4368,7 @@ options_help_aux_output -->
"\tchanges (e.g. because the location of a predicate declaration",
"\tchanges in the Mercury source file).",
"--auto-comments",
- "\tOutput comments in the `<module>.c' file.",
+ "\tOutput comments in the generated target language file.",
% This option is for developers only. Since it can include one C comment inside
% another, the resulting code is not guaranteed to be valid C.
% "--frameopt-comments",
diff --git a/doc/user_guide.texi b/doc/user_guide.texi
index 9b23f38..367ddd0 100644
--- a/doc/user_guide.texi
+++ b/doc/user_guide.texi
@@ -7411,14 +7411,16 @@ by an experimental debugger.
@item --auto-comments
@findex --auto-comments
-Output comments in the @file{@var{module}.c} file.
+Output comments in the generated target language file.
This is primarily useful for trying to understand
-how the generated C code relates to the source code,
+how the generated target language code relates to the source code,
e.g.@: in order to debug the compiler.
The code may be easier to understand if you also use the
- at samp{--no-llds-optimize} option.
+ at samp{--no-llds-optimize} or @samp{--no-mlds-optimize} options.
@findex --no-llds-optimize
@findex --llds-optimize
+ at findex --no-mlds-optimize
+ at findex --mlds-optimize
@sp 1
@item -n-
@@ -7936,7 +7938,7 @@ The set of aspects and their alternatives are:
@table @asis
@item What target language to use, what data representation to use, and (for C) what combination of GNU C extensions to use:
@samp{none}, @samp{reg}, @samp{jump}, @samp{asm_jump},
- at samp{fast}, @samp{asm_fast}, @samp{hl}, @samp{hlc}, @samp{il}, @samp{csharp},
+ at samp{fast}, @samp{asm_fast}, @samp{hl}, @samp{hlc}, @samp{csharp},
@samp{java} and
@samp{erlang}
(the default is system dependent).
@@ -8419,7 +8421,6 @@ For now, this option itself is for developers only.
@findex --gc
@findex --garbage-collection
Specify which method of garbage collection to use.
- at c and @samp{il}.
Grades containing @samp{csharp}, @samp{java}, or @samp{erlang} use
@samp{--gc automatic},
grades containing @samp{.gc} use @samp{--gc boehm},
More information about the reviews
mailing list