[m-rev.] for post-commit review: improve deep profiler usability

[Zoltan Somogyi]

On 02-Oct-2009, Julien Fischer <juliensf at csse.unimelb.edu.au> wrote:
>> +which in turn is a list of other cliques
>> +starting with the caller of the entry point of the clique
>> +and ending with the clique of the @samp{main} predicate.
>
> Not all ancestor contexts end with the clique containing main,
> for example those for cliques that  occur in intialisers and finalisers.
> All ancestors context do end with the "clique" containing the Mercury 
> runtime.

Agreed. However, I am not sure whether that can explained accurately
for the relatively few people who need it without confusing everyone else.

>> +Each clique page lists the closest ancestor cliques,
>> +and then the procedures of the clique.
>> +It gives the cost of each call site in each procedure,
>> +as well as the cost of each procedure in total.
>> +These costs will be just those incurred in the given ancestor context;
>> +the costs incurrent by these call sites
>
> s/incurrent/incurred/

Done.

> Content-wise that looks okay otherwise.  I have two other suggestions:
>
> (1) The ``Using mdprof'' section of the user's guide should be renamed
>     ``Deep profiling'' -- the former is not necessarily what a user
>      looking for information about the deep profiler would look for.
>
> (2) Break the deep profiling entry up into separate subsections, so that
>     the bit on contour exclusion shows up in the table-of-contents;
>     likewise when the section on coverage profiling is added.
>
>     Further to this, we should consider separating out the deep
>     profiling section of the user's guide into a separate section.

I will look at this.

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