[m-rev.] for review: add missing trail segments documentation

[Julien Fischer]

Branches: main, 10.04

Add missing trail segments documentation.

doc/user_guide.texi:
	Document the .trseg grade component and --trail-segments option.

Julien.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.606
diff -u -r1.606 user_guide.texi
--- doc/user_guide.texi	22 Mar 2010 11:46:39 -0000	1.606
+++ doc/user_guide.texi	22 Mar 2010 12:38:31 -0000
@@ -7365,6 +7365,7 @@
 @cindex .memprof (grade modifier)
 @cindex .profdeep (grade modifier)
 @cindex .tr (grade modifier)
+ at cindex .trseg (grade modifier)
 @cindex .gc (grade modifier)
 @cindex .mps (grade modifier)
 @cindex .agc (grade modifier)
@@ -7379,6 +7380,7 @@
 @cindex memprof (grade modifier)
 @cindex profdeep (grade modifier)
 @cindex tr (grade modifier)
+ at cindex trseg (grade modifier)
 @cindex gc (grade modifier)
 @cindex agc (grade modifier)
 @cindex spf (grade modifier)
@@ -7405,7 +7407,7 @@
 (the default is no profiling).

 @item Whether to enable the trail:
- at samp{tr} (the default is no trailing).
+ at samp{tr} and @samp{trseg} (the default is no trailing).

 @item Whether to use single-precision representation of floating point values:
 @samp{spf} (the default is to use double-precision floats)
@@ -7459,7 +7461,9 @@
 @findex --profiling
 @findex --memory-profiling
 @findex --deep-profiling
- at findex --trailing
+ at findex --use-trail
+ at findex --trail-segments
+ at findex --no-trail-segments
 @findex --record-term-sizes-as-words
 @findex --record-term-sizes-as-cells
 @findex --single-prec-float
@@ -7532,7 +7536,10 @@
 @c @code{--profile-calls}.
 @c
 @item @samp{.tr}
- at code{--use-trail}.
+ at code{--use-trail --no-trail-segments}.
+
+ at item @samp{.trseg}
+ at code{--use-trail --trail-segments}.

 @item @samp{.tsw}
 @code{--record-term-sizes-as-words}.
@@ -7910,7 +7917,7 @@
 the underlying implementation's garbage collector.

 @sp 1
- at item @code{--use-trail} (grades: any grade containing @samp{.tr})
+ at item @code{--use-trail} (grades: any grade containing @samp{.tr} or @samp{.trseg})
 @findex --use-trail
 @cindex Trailing
 @cindex Constraint solving
@@ -7921,6 +7928,17 @@
 or for backtrackable destructive update.
 This option is only supported by the C back-ends.

+ at item @code{--trail-segments} (grades: any grade containing @samp{.trseg})
+ at findex --trail-segments
+ at cindex Trailing
+ at cindex Constraint solving
+ at cindex Backtrackable destructive update
+ at cindex Destructive update, backtrackable
+Enable the use of a dynamically sized trail that is composed of small segments.
+This can help to avoid trail exhaustion at the cost of increased execution
+time.
+This option is only supported by the C back-ends.
+
 @sp 1
 @item @code{--parallel}
 @findex --parallel
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------