[m-rev.] for review: --verbose-dump-mlds

[Peter Ross]

fjh wrote:

> Estimated hours taken: 0.75
> Branches: main
>
> compiler/options.m:
> Add a new option `--verbose-mlds-dump'.
>
> compiler/mercury_compile.m:
> When dumping the MLDS, only dump it to the .mlds_dump file if the
> stage was specified with `--verbose-mlds-dump'.  The `--mlds-dump'
> now only controls dumping of the .c_dump and .h_dump files.
>
> doc/user_guide.texi:
> Document the new option.
>
> Workspace: /home/ceres/fjh/mercury
> Index: compiler/options.m
> ===================================================================
> RCS file: /home/mercury1/repository/mercury/compiler/options.m,v
> retrieving revision 1.357
> diff -u -d -r1.357 options.m
> --- compiler/options.m 23 Feb 2002 07:30:46 -0000 1.357
> +++ compiler/options.m 6 Mar 2002 04:19:00 -0000
> @@ -2132,12 +2136,15 @@
>   "\tcorresponding letter occurs in the option argument",
>   "\t(see the Mercury User's Guide for details).",
>   "--dump-mlds <stage number or name>",
> - "\tDump the MLDS (medium level intermediate representation) after",
> - "\tthe specified stage to `<module>.mlds_dump.<num>-<name>',",
> - "\t`<module>.c_dump.<num>-<name>',",
> + "\tDump the MLDS (medium level intermediate representation)",
> + "\tafter the specified stage, as C code,",
> + "\tto`<module>.c_dump.<num>-<name>',",
>   "\tand `<module>.h_dump.<num>-<name>'.",
>   "\tStage numbers range from 1-99.",
>   "\tMultiple dump options accumulate.",
> + "--verbose-dump-mlds <stage number or name>",
> + "\tDump the entire contents of the MLDS, after the specified",
> + "\tstage, to `<module>.mlds_dump.<num>-<name>'.",
>   "--dump-rl",
>   "\tOutput a human readable form of the compiler's internal",
>   "\trepresentation of the generated Aditi-RL code to",

I would suggest changing
    Dump the entire contents of the MLDS
to
    Dump the internal compiler representation of the MLDS


> Index: doc/user_guide.texi
> ===================================================================
> RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
> retrieving revision 1.297
> diff -u -d -r1.297 user_guide.texi
> --- doc/user_guide.texi 27 Feb 2002 17:41:11 -0000 1.297
> +++ doc/user_guide.texi 6 Mar 2002 04:18:20 -0000
> @@ -3972,19 +3972,23 @@
>  U - unify and compare predicates.
>
>  @sp 1
> - at item @var{stage}
> - at itemx --dump-mlds @var{stage}
> + at item --dump-mlds @var{stage}
>  @findex --dump-mlds
>  Dump the MLDS (a C-like intermediate representation) after
> -the specified stage number or stage name.  The raw form of the
> -MLDS is dumped to
> - at file{@var{module}.mlds_dump. at var{num}- at var{name}}.
> -The MLDS is also converted to a C source file/header file pair,
> +the specified stage number or stage name.
> +The MLDS is converted to a C source file/header file pair,
>  which is dumped to @file{@var{module}.c_dump. at var{num}- at var{name}}
>  and @file{@var{module}.h_dump. at var{num}- at var{name}}.
>  Stage numbers range from 1 to 99; not all stage numbers are valid.
>  The special stage name @samp{all} causes the dumping of all stages.
>  Multiple dump options accumulate.
> +
> + at sp 1
> + at item --verbose-dump-mlds @var{stage}
> + at findex --verbose-dump-mlds
> +Dump the raw form of the MLDS, after
> +the specified stage number or stage name, to
> + at file{@var{module}.mlds_dump. at var{num}- at var{name}}.
>
Again make it clearer that you are dumping the internal compiler
representation of the MLDS.

Otherwise it looks fine.


--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------