[m-rev.] diff: tweak trace count documentation

[Julien Fischer]

Estimated hours taken: 0.1
Branches: main, release

Minor tweaks to the trace counts documentation.

NEWS:
 	Add a pointer to the "Trace counts" section of the user's guide.

doc/user_guide.texi:
 	Add some more descriptive section names.  Minor tweak for the
 	description of mdice.

Julien.

Index: NEWS
===================================================================
RCS file: /home/mercury/mercury1/repository/mercury/NEWS,v
retrieving revision 1.409.2.6
diff -u -r1.409.2.6 NEWS
--- NEWS	13 Sep 2006 08:10:41 -0000	1.409.2.6
+++ NEWS	14 Sep 2006 02:08:24 -0000
@@ -83,7 +83,8 @@
  * The declarative debugger can now exploit information from the "code
    footprints" of passed and failed test cases to find bugs with fewer
    questions. We have also added two tools, mslice and mdice, to manipulate
-  files containing such footprints.
+  files containing such footprints.  See the "Trace counts" section of the
+  Mercury User's Guide for details.
  * Subterm dependency tracking in the declarative debugger is now significantly
    faster.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.472.2.5
diff -u -r1.472.2.5 user_guide.texi
--- doc/user_guide.texi	14 Sep 2006 00:55:14 -0000	1.472.2.5
+++ doc/user_guide.texi	14 Sep 2006 01:55:09 -0000
@@ -4691,14 +4691,14 @@
  but not the passing runs.

  @menu
-* mtc::
-* mslice::
-* mdice::
-* mtc_union::
+* Generating trace counts::
+* Slicing::
+* Dicing::
+* Combining trace counts::
  @end menu

- at node mtc
- at subsection mtc
+ at node Generating trace counts
+ at subsection Generating trace counts

  To generate a slice for a program run, first compile the program with deep
  tracing enabled
@@ -4728,8 +4728,8 @@
  It can also be used to help direct a declarative debugging search
  (see @ref{Search Modes}).

- at node mslice
- at subsection mslice
+ at node Slicing
+ at subsection Slicing

  Once a slice has been generated it can be viewed in various ways using the
  mslice tool.
@@ -4796,15 +4796,16 @@
  from the given module.
  @sp 1

- at node mdice
- at subsection mdice
+ at node Dicing
+ at subsection Dicing

  A dice is a comparison between passing and failing runs of a program.
  @sp 1
+Dices are created using the @samp{mdice} tool.
  To use the @samp{mdice} tool one must first generate a set of trace count
  files for passing runs and a set of trace count files for failing runs
-using the @samp{mtc} tool.
-Once this has been done, the @samp{mdice} command
+using the @samp{mtc} tool (@ref{Generating trace counts}).
+Once this has been done @samp{mdice}
  can be used to display a table of statistics
  that compares the passing runs to the failing runs.
  @sp 1
@@ -4892,8 +4893,8 @@

  @sp 1

- at node mtc_union
- at subsection mtc_union
+ at node Combining trace counts
+ at subsection Combining trace counts

  The @samp{mtc_union} tool can be used to combine several trace count files
  into one trace count file.

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