diff options
| author | Andy Wingo <wingo@pobox.com> | 2016-02-01 14:58:34 +0100 |
|---|---|---|
| committer | Andy Wingo <wingo@pobox.com> | 2016-02-01 15:12:36 +0100 |
| commit | 8998f1539f9b998a9ec5f867d3933cdd8f06fc41 (patch) | |
| tree | 1b238bba8b10adf073d9549aeaf48a90ffc45a5f /doc/ref/scheme-using.texi | |
| parent | 4066ee31920d52ec0549ce882f883b92992f894b (diff) | |
| download | guile-8998f1539f9b998a9ec5f867d3933cdd8f06fc41.tar.gz | |
Update statprof documentation; deprecate `with-statprof'
* module/statprof.scm: Remove most of the commentary, as it was
duplicated in the manual and was getting out of date.
(stats): Remove self-secs-per-call and cum-secs-per-call fields as
they can be computed from the other fields.
(statprof-call-data->stats): Adapt.
(statprof-stats-self-secs-per-call):
(statprof-stats-cum-secs-per-call): New functions.
(statprof-display/flat): Don't print the seconds-per-call fields, as
we are no longer stopping the clock around call counters. Anyway
these times were quite misleading.
(with-statprof): Deprecate. It took its keyword arguments at the
beginning; very complicated! Better to use the `statprof' function.
(`statprof' was introduced after `with-statprof' and then
`with-statprof' was adapted to use it.)
* doc/ref/statprof.texi (Statprof): Port this documentation away from
the automatically generated text and update it for the new interfaces
like #:display-style.
* module/system/base/syntax.scm (record-case): Remove comment that
referenced with-statprof. Add comment indicating that record-case
should be replaced.
* doc/ref/scheme-using.texi (Profile Commands): Update to mention
keyword arguments and to link to the statprof documentation.
Diffstat (limited to 'doc/ref/scheme-using.texi')
| -rw-r--r-- | doc/ref/scheme-using.texi | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/ref/scheme-using.texi b/doc/ref/scheme-using.texi index 9334218b6..b7efcb4a9 100644 --- a/doc/ref/scheme-using.texi +++ b/doc/ref/scheme-using.texi @@ -294,8 +294,12 @@ Disassemble a file. Time execution. @end deffn -@deffn {REPL Command} profile exp -Profile execution. +@deffn {REPL Command} profile exp [#:hz hz=100] @ + [#:count-calls? count-calls?=#f] [#:display-style display-style=list] +Profile execution of an expression. This command compiled @var{exp} and +then runs it within the statprof profiler, passing all keyword options +to the @code{statprof} procedure. For more on statprof and on the the +options available to this command, @xref{Statprof}. @end deffn @deffn {REPL Command} trace exp [#:width w] [#:max-indent i] |