[m-rev.] For review: Improved the mmc --make documentation in the User Guide.

Paul Bone pbone at csse.unimelb.edu.au
Mon Mar 8 14:47:03 AEDT 2010


Improved the mmc --make documentation in the User Guide.

Branches: main, 10.04

doc/user_guide.texi:
    Split lines on sentance boundaries in some cases.

    Re-wrote a passive sentance to form an clearer active sentance.

    Split a long sentance into two sentances.

    Inserted a missing 'the'.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.604
diff -u -p -b -r1.604 user_guide.texi
--- doc/user_guide.texi	1 Mar 2010 02:27:30 -0000	1.604
+++ doc/user_guide.texi	8 Mar 2010 03:38:40 -0000
@@ -1006,8 +1006,8 @@ library should be created: @samp{shared}
 In our example, the files @samp{libmypackage.a} and @samp{libmypackage.so}
 should appear in the current directory.
 
-The library is most easily used in other programs if you install it to a
-directory. To install the library, issue the following command:
+Other programs can more easily use a library that is installed.
+To install the library, issue the following command:
 
 @example
 mmc --make --install-prefix <dir> libmypackage.install
@@ -1015,14 +1015,16 @@ mmc --make --install-prefix <dir> libmyp
 
 @noindent
 @samp{mmc} will create the directory @samp{<dir>/lib/mercury} and install the
-library compiled in all valid grades and with all interface files. Because
-several grades are usually compiled, installing the library can be a lengthy
-process. You can specify the set of installed grades using the option
+library there.
+The library will be compiled in all valid grades and with all interface files.
+Because several grades are usually compiled, installing the library can be a lengthy
+process.
+You can specify the set of installed grades using the option
 @samp{--no-libgrade} followed by @samp{--libgrade <grade>} for all grades you
 wish to install.
 
 If no @samp{--install-prefix <dir>} is specified, the library will be installed
-in standard location, next to the Mercury standard library.
+in the standard location, next to the Mercury standard library.
 
 
 @node Using installed libraries with mmc --make
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 489 bytes
Desc: Digital signature
URL: <http://lists.mercurylang.org/archives/reviews/attachments/20100308/4791ae0e/attachment.sig>


More information about the reviews mailing list