[m-rev.] for review (2): simplified user's guide on building and using libraries with mmc

[Peter Wang]

On 2007-03-02, Ondrej Bojar <bojar at csse.unimelb.edu.au> wrote:
> Incorporated Peter's and Julien's comments. The first @ref to "Installing 
> libraries with Mmake" is in the context of Mmake targets only, no reference 
> to mmc --make way is needed.
> I also promote mmc --make instead of Mmake, so I ask for a second review.
> Peter/Julien, could you please look at it? Thanks, O.
> 
> 
> 
> Estimated hours taken: 2.5
> 
> Promoting mmc --make instead of Mmake.

Promote ... 

> @@ -445,8 +450,18 @@
>  @cindex Recompiling
> 
>  Mmake, short for ``Mercury Make'',
> -is a tool for building Mercury programs
> -that is built on top of ordinary or GNU Make @footnote{
> +is a tool for building Mercury programs.
> +The same functionality is now provided in @samp{mmc} directly by using the
> + at samp{--make} option:
> +
> + at example
> +mmc --make @var{main-module}
> + at end example
> +
> + at noindent
> +Therefore, the usage of Mmake is currently discouraged.
> +

I don't see where the "Therefore" comes into it, and "currently" implies
that we are thinking of changing the recommendation.  So just:

    The use of Mmake is discouraged.

> + at example
> +mmc ... --use-grade-subdirs \\
> +        --grade <grade> \\
> +        --search-lib-files-dir <dir> \\
> +        --init-file <dir>/mypackage.init \\
> +        --link-object <dir>/Mercury/<grade>/*/Mercury/lib/libmypackage.a \\
> +    ...
> + at end example
> +
> + at noindent
> +Future versions of @samp{mmc} will probably allow to use just the simple
> + at samp{--ml} and @samp{--mld} options even for non-installed libraries.

Leave this out.  I don't know if there's any such plan, and it would
probably be a long time in coming anyway.

> +
> +
> + at node Building with Mmake
> + at section Building with Mmake
> +
> +Note that the use of Mmake is discouraged. Instead, use the @samp{--make}
> +option to call @samp{mmc} directly.

I don't think this needs repeating.

The rest looks fine to me.

Peter

--------------------------------------------------------------------------
mercury-reviews mailing list
Post messages to:       mercury-reviews at csse.unimelb.edu.au
Administrative Queries: owner-mercury-reviews at csse.unimelb.edu.au
Subscriptions:          mercury-reviews-request at csse.unimelb.edu.au
--------------------------------------------------------------------------