From 621b443b8d352685403e7f3ccaa9f5b539d995f8 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Fri, 16 Jan 2004 17:30:16 +0000 Subject: [PATCH] - add warning that hotshot doesn't work well with threads - fix some markup --- Doc/lib/libhotshot.tex | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Doc/lib/libhotshot.tex b/Doc/lib/libhotshot.tex index 05bc067ed1a..b701a7b13fe 100644 --- a/Doc/lib/libhotshot.tex +++ b/Doc/lib/libhotshot.tex @@ -14,9 +14,15 @@ Hotshot is a replacement for the existing \refmodule{profile} module. As it's written mostly in C, it should result in a much smaller performance impact than the existing \refmodule{profile} module. -\begin{classdesc}{Profile}{logfile\optional{, - lineevents\code{=0}\optional{, - linetimings\code{=1}}}} +\begin{notice}[warning] + The \module{hotshot} profiler does not yet work well with threads. + It is useful to use an unthreaded script to run the profiler over + the code you're interested in measuring if at all possible. +\end{notice} + + +\begin{classdesc}{Profile}{logfile\optional{, lineevents\optional{, + linetimings}}} The profiler object. The argument \var{logfile} is the name of a log file to use for logged profile data. The argument \var{lineevents} specifies whether to generate events for every source line, or just on