[m-rev.] for review: deep profiling on the web page

[Fergus Henderson]

On 01-Aug-2001, Zoltan Somogyi <zs at cs.mu.OZ.AU> wrote:
> For review by anyone familiar with our web site's design. In particular, I'd
> like to know (1) whether my use of mdprof\??echo $root? does what I want it
> to do

The most reliable way of answering this question is to find a machine with php3
installed (e.g. venus), type `make', and look at the generated HTML files.

But note that you need to use "<?echo $root?>" not just "?echo $root?",
so I don't think it will do what you want.  I don't think the "?" needs
to be escaped since I think the magic sequences are "<?" and "?>", not
"?" alone, but I'n no expert on PHP3 so please try it out rather than
taking my word for it.

In general it's a good idea to check that the HTML files render OK in a couple
of your favourite web browsers (e.g. lynx and netscape) before committing
changes to the web pages.  If you're not sure of the portability of the HTML
constructs used, check with validator.w3.org.

> (2) what is the best place in the non-news part
> of the web site to link to the new deep profiling page from.

I think the information section, where you put it, is probably the right place.

> Index: information/include/deep_demo.inc
> ===================================================================
> RCS file: deep_demo.inc
> diff -N deep_demo.inc
> --- /dev/null	Fri Dec  1 02:25:58 2000
> +++ deep_demo.inc	Wed Aug  1 16:51:09 2001
> @@ -0,0 +1,123 @@
> +<h2>The Mercury deep profiler</h2>
> +
> +<h3>Objective</h3>
> +
> +The old Mercury profiler, mprof, was a straightforward clone
...
> +than C programs do.
> +
> +For example, the most expensive predicates in the Mercury compiler are

You need <p> between paragraphs, not just blank lines.
This applies everywhere.

> +You can ask for a program to be compiled with deep profiling instrumentation
> +by compiling it in a grade that includes the grade component "profdeep",
> +e.g. asm_fast.gc.profdeep.

Users shouldn't have to remember mystic incantations like
"asm_fast.gc.profdeep" in order to use Mercury.  You should recommend using the
`--deep-profiling' option, not the `profdeep' grade component, like we do in the
Mercury user's guide for debugging and (ordinary) profiling.  So change that to

	... by using the `--deep-profiling' option to `mmc',
	or by including `GRADEFLAGS = --deep-profiling' in your `Mmakefile'.

> +Programs compiled with deep profiling can generate large amounts of data,
> +since deep profiling yields very detailed information.
> +We have therefore implemented the postprocessing program as a web server.

Hmm, I don't think "web server" is quite the right term here.
That makes me think that the program implements the HTTP protocol, like apache,
rather than being just a CGI program.

Maybe "web service"??
Or perhaps "CGI-based web service"?

Otherwise that change looks fine.

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