show-flat-profile

$Revision: 5.0.2.2 $

Function

Package: PROFILER

Arguments: (&key stream current-profile verbose)

This function prints a flat profile based on the most recently collected profile data to the output stream specified by the :stream keyword argument. The default value of the stream keyword argument is *standard-output*.

The current-profile keyword argument specifies the profile data to be displayed. If no value is specified, data from the last-run profile will be displayed. If a value is specified, it must be a profile saved with save-current-profile, in which case data from that profile will be displayed.

The verbose keyword argument controls whether or not messages about the progress of the analysis are printed to *standard-output*. The messages will be printed if the value is non-nil and they will not be printed if the value is nil. The value defaults to nil. (Note that in the default, both the messages and the result are printed to *standard-output* so if you rebind *standard-output* to be a stream open to a file, the messages will be printed to the file as well.)

This function returns no value.

If the profiler is still running when this function is called, the profiler will be stopped, then analysis and display of the results will occur. After show-flat-profile has been applied to a profile, the status of that profile (as returned by profiler-status) becomes :analyzed if it was not already in that state.

See profiling.htm for general information on profiling. Note that the profiler is not available with some Allegro CL products.

The general documentation description is in introduction.htm. The index in index.htm.