summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libhotshot.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2004-01-16 17:30:16 (GMT)
committerFred Drake <fdrake@acm.org>2004-01-16 17:30:16 (GMT)
commit621b443b8d352685403e7f3ccaa9f5b539d995f8 (patch)
tree36a236b5b56019dede5851d055731c35eb84358a /Doc/lib/libhotshot.tex
parent990a46b732bbdc2dba299ccec318ad2f71a6e6e2 (diff)
downloadcpython-621b443b8d352685403e7f3ccaa9f5b539d995f8.zip
cpython-621b443b8d352685403e7f3ccaa9f5b539d995f8.tar.gz
cpython-621b443b8d352685403e7f3ccaa9f5b539d995f8.tar.bz2
- add warning that hotshot doesn't work well with threads
- fix some markup
Diffstat (limited to 'Doc/lib/libhotshot.tex')
-rw-r--r--Doc/lib/libhotshot.tex12
1 files changed, 9 insertions, 3 deletions
diff --git a/Doc/lib/libhotshot.tex b/Doc/lib/libhotshot.tex
index 05bc067..b701a7b 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