[m-rev.] for review: deep_profiler/README

[Fergus Henderson]

Estimated hours taken: 1
Branches: main

Improve the documentation of deep profiling.

deep_profiler/README:
	New file, containing pointers to the different sources of
	documentation on deep profiling.

runtime/mercury_deep_profiling.h:
runtime/mercury_deep_profiling.c:
	Add a comment pointing to deep_profiler/README.

Workspace: /home/jupiter/fjh/ws-jupiter/mercury
Index: deep_profiler/README
===================================================================
RCS file: deep_profiler/README
diff -N deep_profiler/README
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ deep_profiler/README	24 Feb 2004 08:28:11 -0000
@@ -0,0 +1,17 @@
+For documentation on the deep profiler, see the following:
+
+  - The "Deep Profiler" section of the Mercury web page
+    <http://www.cs.mu.oz.au/mercury/information/deep_demo.html>
+    gives an overview of what deep profiling is.
+
+  - The deep profiling paper on our web site, "Deep profiling:
+    engineering a profiler for a declarative programming language"
+    <http://www.cs.mu.oz.au/mercury/information/papers.html#mu_01_24>
+    explains in detail what deep profiling is, why it is needed,
+    and how it is implemented in the Mercury compiler.
+
+  - The "Using mdprof" section of the "Profiling" chapter of the
+    Mercury user's guide explains how to use it.
+
+  - The file deep_profiler/notes/deep_profiling.html gives an overview of
+    the specifics details of our implementation of deep profiling.
Index: runtime/mercury_deep_profiling.c
===================================================================
RCS file: /home/mercury1/repository/mercury/runtime/mercury_deep_profiling.c,v
retrieving revision 1.11
diff -u -d -r1.11 mercury_deep_profiling.c
--- runtime/mercury_deep_profiling.c	2 Apr 2003 23:22:17 -0000	1.11
+++ runtime/mercury_deep_profiling.c	11 Feb 2004 23:31:07 -0000
@@ -7,6 +7,9 @@
 /*
 **	Deep profiling module
 **
+**	See ../deep_profiler/README for some pointers to documentation
+**	on deep profiling.
+**
 **	Authors: conway, zs
 */
 
Index: runtime/mercury_deep_profiling.h
===================================================================
RCS file: /home/mercury1/repository/mercury/runtime/mercury_deep_profiling.h,v
retrieving revision 1.11
diff -u -d -r1.11 mercury_deep_profiling.h
--- runtime/mercury_deep_profiling.h	20 Oct 2003 07:29:31 -0000	1.11
+++ runtime/mercury_deep_profiling.h	11 Feb 2004 23:31:34 -0000
@@ -6,6 +6,9 @@
 
 /*
 ** mercury_deep_profiling.h -- definitions for deep profiling.
+**
+** See ../deep_profiler/README for some pointers to documentation on
+** deep profiling.
 */
 
 #ifndef MERCURY_DEEP_PROFILING_H

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
The University of Melbourne         |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------