summaryrefslogtreecommitdiff
path: root/doc/ref/statprof.texi
diff options
context:
space:
mode:
authorMike Gran <spk121@yahoo.com>2017-03-06 22:57:03 -0800
committerMike Gran <spk121@yahoo.com>2017-03-06 23:08:25 -0800
commitf5b362586d7622c408d4402c7cb496c45ffb56e8 (patch)
treedc29f257b5b753a5b2d82968b09699a718f7f288 /doc/ref/statprof.texi
parent4ce31fd387e89c8f64716866705a5a34651506ea (diff)
downloadguile-wip-itimer-checks.tar.gz
Check for working profiling and virtual itimerswip-itimer-checks
* configure.ac (HAVE_USABLE_GETITIMER_PROF, HAVE_USABLE_GETITIMER_VIRTUAL): new tests * doc/ref/posix.texi (setitimer, getitimer): document provided? 'ITIMER_VIRTUAL and 'ITIMER_PROF * doc/ref/statprof.texi (statprof): document ITIMER_PROF requirements * libguile/scmsigs.c (scm_setitimer, scm_getitimer): document (provided? 'ITIMER_VIRTUAL) and (provided? 'ITIMER_READ) (scm_init_scmsigs): add features ITIMER_VIRTUAL and ITIMER_PROF * test-suite/tests/asyncs.test ("prevention via sigprof"): throw when unsupported * test-suite/tests/signals.test: throw when not supported * test-suite/tests/statprof.test: throw when not supported
Diffstat (limited to 'doc/ref/statprof.texi')
-rw-r--r--doc/ref/statprof.texi12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/ref/statprof.texi b/doc/ref/statprof.texi
index 65f0d473b..850c5bd2e 100644
--- a/doc/ref/statprof.texi
+++ b/doc/ref/statprof.texi
@@ -1,6 +1,6 @@
@c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual.
-@c Copyright (C) 2013, 2015 Free Software Foundation, Inc.
+@c Copyright (C) 2013, 2015, 2017 Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions.
@node Statprof
@@ -128,17 +128,21 @@ After the @var{thunk} has been profiled, print out a profile to
@var{port}. If @var{display-style} is @code{flat}, the results will be
printed as a flat profile. Otherwise if @var{display-style} is
@code{tree}, print the results as a tree profile.
+
+Note that @code{statprof} requires a working profiling timer. Some
+platforms do not support profiling timers. @code{(provided?
+'ITIMER_PROF)} can be used to check for support of profiling timers.
@end deffn
Profiling can also be enabled and disabled manually.
-@deffn {Scheme Procedure} statprof-active?
+@deffn {Scheme Procedure} statprof-active?
Returns @code{#t} if @code{statprof-start} has been called more times
than @code{statprof-stop}, @code{#f} otherwise.
@end deffn
-@deffn {Scheme Procedure} statprof-start
-@deffnx {Scheme Procedure} statprof-stop
+@deffn {Scheme Procedure} statprof-start
+@deffnx {Scheme Procedure} statprof-stop
Start or stop the profiler.
@end deffn