[m-rev.] diff: document `--analyse-trail-usage'

[Julien Fischer]

Estimated hours taken: 0.1
Branches: main

compiler/options.m:
doc/user_guide.texi:
	Update the documentation of the `--analyse-trail-usage'
	option and add it to the user guide.

	Fix typo: s/predicates/pedicates/

Julien.

Index: compiler/options.m
===================================================================
RCS file: /home/mercury1/repository/mercury/compiler/options.m,v
retrieving revision 1.484
diff -u -r1.484 options.m
--- compiler/options.m	19 Dec 2005 02:13:53 -0000	1.484
+++ compiler/options.m	20 Dec 2005 05:09:53 -0000
@@ -3021,7 +3021,7 @@
 % "--trace-prof" is not documented because if is only intended for developers
 % of the deep profiler.
 %       "--trace-prof"",
-%       "\tEnable tracing of deep profiling service pedicates.",
+%       "\tEnable tracing of deep profiling service predicates.",
 % I/O tabling is deliberately not documented. It is mean to be switched on,
 % with consistent parameters, in debugging grades, and to be consistently
 % switched off in non-debugging grades. Inconsistent use of the options
@@ -3978,11 +3978,12 @@
         "--analyse-trail-usage",
         "\tEnable trail usage analysis.  Identify those",
         "\tprocedures that will not modify the trail.",
-        "\tThis information can be used to reduce the overhead",
+        "\tThis information is used to reduce the overhead",
         "\tof trailing."
 % `--no-optimize-trail-usage' is a developer-only option.  It
 % is intended for benchmarking the trail usage optimization.
-% Otherwise, there is usually not any point in turning it off.
+% Otherwise, it should not be turned off as doing so interferes with
+% the results of the trail usage analysis.
         %"--no-optimize-trail-usage",
         %"\tDo not try and restrict trailing to those parts",
         %"\tof the program that actually use it."
Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.461
diff -u -r1.461 user_guide.texi
--- doc/user_guide.texi	19 Dec 2005 02:13:55 -0000	1.461
+++ doc/user_guide.texi	20 Dec 2005 05:09:57 -0000
@@ -7150,6 +7150,14 @@
 @c values that higher-order valued variables can take.
 @c Some optimizations can make use of this information.

+ at sp 1
+ at item --analyse-trail-usage
+ at findex --analyse-trail-usage
+Enable trail usage analysis.  Identify those
+procedures that will not modify the trail.
+This information is used to reduce the overhead
+of trailing.
+
 @c @sp 1
 @c @item --untuple
 @c @findex --untuple

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