Commit 621b443b authored by Fred Drake's avatar Fred Drake

- add warning that hotshot doesn't work well with threads

- fix some markup
parent 990a46b7
......@@ -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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment