profiler-tree-to-function

profiler-tree-to-function Function

Summary

Prints a reversed call tree of profiled code below a given function.

Package

hcl

Signature

profiler-tree-to-function function-name &optional max-depth

Arguments

`function-name`⇩	A symbol naming a function.
`max-depth`⇩	A number or `nil`.

Description

The function profiler-tree-to-function prints a tree with root function-name whose children are the callers of function-name and their callers. Note that the tree is reversed, that is, callers appear under their callees.

profiler-tree-to-function uses the data from the previous 'profile session' with style :tree. A profile session ends at the end of profile or when stop-profiling is called, or when the Profiler tool finishes profiling.

In both cases the counts of profile calls is the total counts of the calls to function-name. Note that the percentages (the number in parentheses) are percentages from the total number of profile calls, rather than from the numbers of calls to function-name.

max-depth limits the depth of tree that is printed. If max-depth is nil there is no limit on the depth that is printed. The default value of max-depth is 7.